[DOCS-11230] The example API request is incorrect in https://docs.atlas.mongodb.com/reference/api/process-disks-measurements/ Created: 19/Jan/18  Updated: 11/Sep/18  Resolved: 19/Jan/18

Status: Closed
Project: Documentation
Component/s: Atlas
Affects Version/s: None
Fix Version/s: None

Type: Bug Priority: Major - P3
Reporter: Susan Hannon Assignee: Ravind Kumar (Inactive)
Resolution: Done Votes: 0
Labels: .1
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:
Days since reply: 6 years, 3 weeks, 5 days ago
Epic Link: DOCSP-2982
Story Points: 0.1

 Description   

The below example API request quoted on our documentation in Get Measurements of a Disk for a MongoDB Process is incorrect as it does not specify that the user needs to insert the disk partition name.

curl -u "<ATLAS-USERNAME>:<API-KEY>" --digest -i "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/processes/{HOST}:{PORT}/disks/monitoring/granularity=PT5M&period=PT5M?pretty=true"

The above request results in a 404 error message.

I believe the example API request should be:

curl -u "ATLAS-USERNAME:API-KEY" --digest -i "https://cloud.mongodb.com/api/atlas/v1.0/groups/59fb49213b34b92edc3aec26/processes/txup-mga-001-shard-00-00-0gmrd.azure.mongodb.net:27017/disks/{disk partition name}/measurements?granularity=PT5M&period=PT5M"

Note the user should be able to obtain the disk partition name by running https://docs.atlas.mongodb.com/reference/api/process-disks/.

Thank you in advance for any assistance with improving this.



 Comments   
Comment by Ravind Kumar (Inactive) [ 19/Jan/18 ]

ToDo:

  • Fix endpoint in example request
  • Fix endpoint at top of page

Should be {{/disks/

{DISK-ID}

/measurements}}

Generated at Thu Feb 08 08:02:22 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.