本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
DescribeStorageSystemResourceMetrics
返回 DataSync Discovery 收集的有关本地存储系统中特定资源的信息,包括性能数据和容量使用情况。
请求语法
{
"DiscoveryJobArn": "string
",
"EndTime": number
,
"MaxResults": number
,
"NextToken": "string
",
"ResourceId": "string
",
"ResourceType": "string
",
"StartTime": number
}
请求参数
有关所有操作的通用参数的信息,请参阅通用参数。
请求接受采用 JSON 格式的以下数据。
- DiscoveryJobArn
-
指定您在其中计划的发现作业的 Amazon Resource Name(ARN)。
类型:字符串
长度限制:最大长度为 256。
模式:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}/job/discovery-job-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
必需:是
- EndTime
-
指定发现作业运行总持续时间内的时间。要查看在特定时间范围内收集的信息,请将此参数与配合使用
StartTime
。类型:Timestamp
必需:否
- MaxResults
-
指定您想要在响应中得到多少结果。
类型:整数
有效范围:最小值为 1。最大值为 100。
必需:否
- NextToken
-
指定一个不透明的字符串,该字符串指示响应中下一个结果列表的开始位置。
类型:字符串
长长长长长长长长长长长长长长长长长长长长长
模式:
[a-zA-Z0-9=_-]+
必需:否
- ResourceId
-
指定您想要了解的存储系统资源的通用唯一标识符 (UUID)。
类型:字符串
模式:
[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}
必需:是
- ResourceType
-
指定您想要了解的存储系统资源类型。
类型:字符串
有效值:
SVM | VOLUME | CLUSTER
必需:是
- StartTime
-
指定发现作业运行总持续时间内的时间。要查看在特定时间范围内收集的信息,请将此参数与配合使用
EndTime
。类型:Timestamp
必需:否
响应语法
{
"Metrics": [
{
"Capacity": {
"LogicalUsed": number,
"Provisioned": number,
"Used": number
},
"P95Metrics": {
"IOPS": {
"Other": number,
"Read": number,
"Total": number,
"Write": number
},
"Latency": {
"Other": number,
"Read": number,
"Write": number
},
"Throughput": {
"Other": number,
"Read": number,
"Total": number,
"Write": number
}
},
"ResourceId": "string",
"ResourceType": "string",
"Timestamp": number
}
],
"NextToken": "string"
}
响应元素
如果此操作成功,则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回的以下数据。
- Metrics
-
您的发现任务收集的有关存储系统资源的详细信息。
类型:ResourceMetrics 对象数组
- NextToken
-
不透明的字符串,表示响应中下一个结果列表的开始位置。
类型:字符串
长长长长长长长长长长长长长长长长长长长长长
模式:
[a-zA-Z0-9=_-]+
错误
有关所有操作常见错误的信息,请参阅常见错误。
- InternalException
-
当AWS DataSync服务中发生错误时,会引发此异常。
HTTP 状态代码:500
- InvalidRequestException
-
当客户端提交格式错误的请求时,会引发此异常。
HTTP 状态代码:400
示例
示例请求
以下示例请求有关本地存储系统中卷的信息。
{ "DiscoveryJobArn": "arn:aws:datasync:us-east-1:123456789012:system/storage-system-abcdef01234567890/job/discovery-job-12345678-90ab-cdef-0abc-021345abcdef6", "ResourceType": "VOLUME", "ResourceId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }
示例响应
以下示例响应包括有关该卷的性能和容量信息。
{ "Metrics": [ { "Timestamp": "2023-01-10T13:54:11-05:00", "P95Metrics": { "IOPS": { "Read": 251.0, "Write": 44.0, "Other": 17.0, "Total": 345.0 }, "Throughput": { "Read": 2.06, "Write": 0.88, "Other": 0.11, "Total": 2.17 }, "Latency": { "Read": 0.06, "Write": 0.07, "Other": 0.13 } }, "Capacity": { "Used": 409600, "Provisioned": 1099511627776 }, "ResourceId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "ResourceType": "VOLUME" } ] }
另请参阅
有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: