返回一个 MongoDB 进程的一个磁盘的测量值
返回指定项目的指定主机的一个磁盘或分区的测量值。返回的值可以是以下值之一:
- 用于 MongoDB 进程的磁盘分区的 I/O 操作吞吐量
- 向磁盘分区发出请求和由磁盘分区提出请求的时间百分比
- 用于 MongoDB 进程的磁盘分区的每种操作类型的延迟
- 磁盘分区上用于 MongoDB 进程的可用和已用磁盘空间量
要使用此资源,请求的服务帐户或API密钥必须具有“项目只读”角色。
路径参数
-
用于标识项目的唯一 24-十六进制数字字符串。 使用 /groups 端点检索身份验证的用户有权访问权限的所有项目。
注意:群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。
格式应符合以下模式:
^([a-f0-9]{24})$
。 -
测量所适用的磁盘或分区的用户可读标签。
-
主机名和为 MongoDB 进程提供服务的互联网号码分配机构 (IANA) 端口的组合。主机必须是运行 MongoDB 进程 (
mongod
或mongos
) 的主机的主机名、完全限定域名 (FQDN) 或 Internet 协议地址(IPv4 或 IPv6)。该端口必须是 MongoDB 进程侦听请求的 IANA 端口。格式应符合以下模式:
^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?(\:[0-9]{4,5})$
。
查询参数
-
指示应用程序是否将响应包装在
envelope
JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题,请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。默认值为
false
。 -
指示响应正文是否应采用 prettyprint 格式的标记。
默认值为
false
。Prettyprint -
为该 MongoDB 进程请求的一个或多个度量类型。如果省略,资源将返回所有度量值。如需为
m
指定多个值,请为每个值重复输入m
参数。指定适用于指定主机的度量值。如果指定了任何无效的度量值,MongoDB Cloud 将返回错误信息。至少
1
个但不超过10
个元素。值为DISK_PARTITION_IOPS_READ
、MAX_DISK_PARTITION_IOPS_READ
、DISK_PARTITION_IOPS_WRITE
、MAX_DISK_PARTITION_IOPS_WRITE
、DISK_PARTITION_IOPS_TOTAL
、MAX_DISK_PARTITION_IOPS_TOTAL
、DISK_PARTITION_LATENCY_READ
、MAX_DISK_PARTITION_LATENCY_READ
、DISK_PARTITION_LATENCY_WRITE
、MAX_DISK_PARTITION_LATENCY_WRITE
、DISK_PARTITION_SPACE_FREE
、MAX_DISK_PARTITION_SPACE_FREE
、DISK_PARTITION_SPACE_USED
、MAX_DISK_PARTITION_SPACE_USED
、DISK_PARTITION_SPACE_PERCENT_FREE
、MAX_DISK_PARTITION_SPACE_PERCENT_FREE
、DISK_PARTITION_SPACE_PERCENT_USED
、MAX_DISK_PARTITION_SPACE_PERCENT_USED
、DISK_PARTITION_THROUGHPUT_READ
、DISK_PARTITION_THROUGHPUT_WRITE
或DISK_QUEUE_DEPTH
。 -
持续时间,用于指定 Atlas 报告指标的时间间隔。此参数以 UTC 格式的 ISO 8601 持续时间格式表示其值。
-
Atlas 报告指标的持续时间。此参数以 UTC 格式的 ISO 8601 持续时间格式表示其值。在未设置开始和结束时包含此参数。
-
MongoDB Cloud 开始报告指标的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。未设置周期时,请包含此参数。
-
MongoDB Cloud 停止报告指标的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。未设置周期时,请包含此参数。
atlas api monitoringAndLogs getGroupProcessDiskMeasurements --help
import (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20230101001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.GetGroupProcessDiskMeasurementsApiParams{}
sdkResp, httpResp, err := client.MonitoringandLogsApi.
GetGroupProcessDiskMeasurementsWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2023-01-01+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2023-01-01+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true"
{
"databaseName": "string",
"end": "2025-05-04T09:42:00Z",
"granularity": "PT1M",
"groupId": "32b6e34b3d91647abb20e7b8",
"hostId": "mongodb.example.com:27017",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"measurements": [
{
"dataPoints": [
{
"timestamp": "2025-05-04T09:42:00Z",
"value": 42.0
}
],
"name": "string",
"units": "BYTES"
}
],
"partitionName": "string",
"processId": "mongodb.example.com:27017",
"start": "2025-05-04T09:42:00Z"
}
{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}
{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}
{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}