ワークグループ名、説明、アラート情報などのワークグループの詳細を照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
smc:DescribeWorkgroups |
list |
*すべてのリソース。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| WorkgroupId |
array |
任意 |
ワークグループ ID のリスト。最大 50 個のワークグループ ID を指定できます。 |
|
|
string |
任意 |
ワークグループ ID。 |
w-bp10geepnj916e3d**** |
|
| Name |
string |
任意 |
ワークグループ名。 |
test |
| Status |
string |
任意 |
ワークグループのステータス。有効な値:
|
InProgress |
| PageNumber |
integer |
任意 |
ワークグループリストのページ番号。ページは 1 から始まります。デフォルト値: 1。 |
1 |
| PageSize |
integer |
任意 |
ページングクエリの 1 ページあたりのエントリ数。最大値: 50。デフォルト値: 10。 |
10 |
| Tag |
array<object> |
任意 |
タグ配列。配列の長さ: 1~20。配列に複数のタグオブジェクトが含まれる場合、タグキーは一意である必要があります。 |
|
|
object |
任意 |
タグオブジェクト。 |
||
| Key |
string |
任意 |
ワークグループのタグキー。タグキーは最大 128 文字です。このパラメーターを指定する場合、値は空の文字列にできません。値の先頭は aliyun または acs: にできず、http:// または https:// を含めることはできません。 |
TestKey |
| Value |
string |
任意 |
ワークグループのタグ値。タグ値は最大 128 文字です。このパラメーターを指定する場合、値は空の文字列にできます。値に http:// または https:// を含めることはできません。 |
TestValue |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答パラメーター。 |
||
| RequestId |
string |
リクエスト ID。 |
2D69A58F-345C-4FDE-88E4-BF518948**** |
| TotalCount |
integer |
ワークグループの総数。 |
1 |
| PageSize |
integer |
ページングクエリの 1 ページあたりのエントリ数。最大値: 50。デフォルト値: 10。 |
10 |
| PageNumber |
integer |
ワークグループリストのページ番号。 |
1 |
| Workgroups |
object |
||
| Workgroup |
array<object> |
ワークグループの詳細。 |
|
|
array<object> |
ワークグループオブジェクト。 |
||
| WorkgroupId |
string |
ワークグループ ID。 |
w-bp10geepnj916e3d**** |
| Name |
string |
ワークグループ名。 |
testWorkgroupName |
| Description |
string |
ワークグループの説明。 |
test |
| Status |
string |
ワークグループのステータス。有効な値:
|
InProgress |
| Warnings |
object |
||
| Warning |
array<object> |
ワークグループのアラート情報のリスト。複数のタイプのアラートが含まれる場合があります。 |
|
|
array<object> |
アラート情報。 |
||
| WarningType |
string |
アラート機能のタイプ。有効な値:
|
InError |
| SourceIds |
object |
||
| SourceId |
array |
問題が発生している移行元のリスト。 |
|
|
string |
問題が発生している移行元の ID。 |
s-bp1h7ymebl7swbt4**** |
|
| Tags |
object |
||
| Tag |
array<object> |
ワークグループのタグ情報。 |
|
|
object |
ワークグループのタグ情報。 |
||
| Key |
string |
ワークグループのタグキー。 |
TestKey |
| Value |
string |
ワークグループのタグ値。 |
TestValue |
例
成功レスポンス
JSONJSON
{
"RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****",
"TotalCount": 1,
"PageSize": 10,
"PageNumber": 1,
"Workgroups": {
"Workgroup": [
{
"WorkgroupId": "w-bp10geepnj916e3d****",
"Name": "testWorkgroupName",
"Description": "test",
"Status": "InProgress",
"Warnings": {
"Warning": [
{
"WarningType": "InError",
"SourceIds": {
"SourceId": [
"s-bp1h7ymebl7swbt4****"
]
}
}
]
},
"Tags": {
"Tag": [
{
"Key": "\t\nTestKey",
"Value": "TestValue"
}
]
}
}
]
}
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 500 | InternalError | An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket. | リクエストの処理中にエラーが発生しました。もう一度お試しください。それでも問題が解決しない場合、チケットを起票してください。 |
| 403 | Forbidden.Unauthorized | A required authorization for the specified action is not supplied. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。