利用可能なタグを 1 つ以上記述します。ECS リソースタイプ、リソース ID、タグキー、またはタグ値の指定など、条件をタグに一致させるように設定できます。 条件に AND(&&)演算子を使用し、演算結果の特定のリストを返します。
特に、タグキー(Tag.n.Key
)が指定されているが、タグ値(Tag.n.Value
)が指定されていない場合、タグキーに関連する全てのタグが照会される。タグ key-value が指定されている場合、照会された key-value と正確に一致するタグ。
リクエストパラメーター
Action | String | はい | このインターフェイス名、値: DescribeTags。 |
RegionId | String | はい | タグが属する領域の ID。詳細について、DescribeRegionsをご参照ください。 |
ResourceId | String | いいえ | リソース ID を示します。たとえば、ResourceType をinstance に設定すると、ResourceId は InstanceId として解釈できます。
|
ResourceType | String | いいえ | タグをバインドするときのリソースのタイプを示します。オプションの値:
|
Tag.n.Key | String | いいえ | これはタグキーを示しており、n は 1 ~ 5 です。 |
Tag.n.Value | String | いいえ | これはタグ値を示しており、n は 1 ~ 5 です。 |
PageSize | Integer | いいえ | デフォルト値は 50、最大値は 100 です。 |
PageNumber | Integer | いいえ | これはインスタンスステータスリストのページ番号を示します。デフォルトのページ番号は 1 です。 |
レスポンスパラメーター
RequestId | String | リクエスト ID を示します。 |
TagSet | TagSetItem | 実際に返されるコンテンツの構造体リストを示します。 |
PageSize | Integer | デフォルト値は 50、最大値は 100 です。 |
PageNumber | Integer | インスタンスステータスリストのページ番号を示します。デフォルトのページ番号は 1 です。 |
TotalCount | Integer | インスタンスの総数を示します。 |
例
リクエストの例
https://ecs.aliyuncs.com/?Action=AddTags
&ResourceId=s-946ntx4wr
&ResourceType=snapshot
&RegionId=cn-shenzhen
&Tag.1.Key=test
&Tag.1.Value=api
&<Common Request Parameter>
戻り値の例
XML 形式
<DescribeTagsResponse>
<RequestId>B04B8CF3-4489-432D-83BA-6F128E4F2295</RequestId>
<PageNumber>1</PageNumber>
<PageSize>50</PageSize>
<Tags>
<Tag>
<TagKey>test</TagKey>
<TagValue>api</TagValue
</Tag>
</Tags>
<TotalCount>1</TotalCount>
</DescribeTagsResponse>
JSON 形式
{
"PageNumber": 1,
"PageSize": 50,
"RequestId": "B04B8CF3-4489-432D-83BA-6F128E4F2295",
"Tags": {
"Tag": [
{
"TagKey": "test",
"TagValue": "api"
}
]
},
"TotalCount": 1
}
エラーコード
MissingParameter | このリクエストの処理に必須の入力パラメーター RegionId が指定されていません。 | 400 | RegionId パラメーターが指定されていません。 |
InvalidRegionId.NotFound | 指定された RegionId は存在しません。 | 404 | 指定された RegionId は存在しません。 |
InvalidResourceType.NotFound | 指定された ResourceType はレコードに存在しません。 | 404 | 指定された ResourceType は存在しません。 |
InvalidTagCount | 指定されたタグは許可された範囲を超えています。 | 400 | 5 個を超えるタグが指定されています。 |