2023 年 12 月 7 日より、バージョン 1 DataSync のエージェントは廃止されます。 DataSync コンソールの [エージェント] ページをチェックして、影響を受けるエージェントがいないか確認してください。その場合は、データ転送やストレージ検出の中断を避けるため、その前にそれらのエージェントを交換してください。さらにサポートが必要な場合は、お問い合わせくださいAWS Support
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
DescribeStorageSystemResourceMetrics
DataSync Discoveryがオンプレミスストレージシステム内の特定のリソースについて収集したパフォーマンスデータや容量使用量などの情報を返します。
リクエストの構文
{
"DiscoveryJobArn": "string",
"EndTime": number,
"MaxResults": number,
"NextToken": "string",
"ResourceId": "string",
"ResourceType": "string",
"StartTime": number
}リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下の JSON 形式のデータを受け入れます。
- DiscoveryJobArn
-
オンプレミスストレージシステムに関する情報を収集する検出ジョブの Amazon リソースネーム (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。型: タイムスタンプ
分位数は、確率分布を等しい確率の領域に分割したものです。
- MaxResults
-
レスポンスに含める結果の数を指定します。
型: 整数
有効範囲: 最小値 は 1 最大値は 100 です。
必須: いいえ
- NextToken
-
レスポンス内の次の結果リストの開始位置を示す不透明な文字列を指定します。
型: 文字列
長さの制限: 最大長は 65,535 です。
パターン:
[a-zA-Z0-9=_-]+必須: いいえ
- ResourceId
-
情報が必要なストレージシステムリソースのユニバーサルユニーク識別子 (UUID) を指定します。
型: 文字列
Pattern:
[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。型: タイムスタンプ
分位数は、確率分布を等しい確率の領域に分割したものです。
レスポンスの構文
{
"Metrics": [
{
"Capacity": {
"ClusterCloudStorageUsed": number,
"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
-
レスポンス内の次の結果リストの開始位置を示す不透明な文字列。
型: 文字列
長さの制限: 最大長は 65,535 です。
パターン:
[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 SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
