1 つ以上の ECS リソースにアタッチされているタグのリストを照会します。
説明
- 検索オブジェクトを決定するには、リクエストに次のパラメーターを含める必要があります。
ResourceId.N
またはTag.N
(つまり、Tag.N.Key
およびTag.N.Value
) Tag.N
はリソースタグで、キーと値のペアで構成されます。Tag.N.Key
のみ指定されている場合、タグキーに関連付けられているすべてのタグ値が返されます。Tag.N.Value
のみ指定されている場合、エラーInvalidParameter.TagValue
が報告されます。-
Tag.N
およびResource.N
を同時に指定する場合、ResourceId.N
は、タグのキーと値のすべての入力に一致する必要があります。 - 複数のタグのキーと値のペアを同時に指定した場合、返される結果は、指定された複数のキーと値のペアを含むリソースです。
デバッグ
API Explorer を使用すると、API を簡単にデバッグし、SDK コード例を自動的に生成し、API をすばやく検索できます。
リクエストパラメーター
パラメーター | データ型 | 必須/任意 | 値の例 | 説明 |
---|---|---|---|---|
RegionId | String | 必須 | cn-hangzhou |
ECS リソースが属するリージョンの ID。 詳細については、 DescribeRegions を呼び出して最新のリージョンリストを取得してください。 |
ResourceType | String | 必須 | instance |
ECS リソースのタイプ。 有効な値:
|
Action | String | 任意 | ListTagResources |
この操作の名前。 値:ListTagResources。 |
NextToken | String | 任意 | caeba0bbb2be03f84eb48b699f0a4883 |
次のクエリのトークン。 |
ResourceId.N | RepeatList | 任意 | i-instanceid1 |
ECS リソースの ID 。 N の値の範囲 : 1~50 。 |
Tag.N.Key | String | 任意 | FinanceDept |
タグの値。 N の値の範囲 : 1~20 。 パラメーターは NULL 文字列にできません。 パラメーターの長さは 1~64 文字にする必要があります。 aliyun または acs: で始めることはできません。また、http:// または https:// を含めることはできません。 |
Tag.N.Value | String | 任意 | FinanceJoshua |
タグの値。 N の値の範囲 : 1~20 。 パラメーターは NULL 文字列にできます。 パラメーターの長さは 1~128 文字にする必要があります。 aliyun または acs: で始めることはできません。また、http:// または https:// を含めることはできません。 |
レスポンスパラメーター
パラメーター | データ型 | 値の例 | 説明 |
---|---|---|---|
NextToken | String | caeba0bbb2be03f84eb48b699f0a4883 |
次のクエリのトークン。 |
RequestId | String | DE65F6B7-7566-4802-9007-96F2494AC5XX |
リクエスト ID。 |
TagResources |
リソース ID、リソースタイプ、タグキーなどの情報を含むリソースとそのタグのコレクション。 |
||
└ResourceId | String | i-bp1j6qtvdm8w0z1o0XXX |
リソースID。 |
└ResourceType | String | instance |
リソースタイプ。 |
└TagKey | String | FinanceDept |
タグのキー。 |
└TagValue | String | FinanceJoshua |
タグの値。 |
例
リクエストの例
https://ecs.aliyuncs.com/?Action=ListTagResources
&RegionId=cn-hangzhou
&ResourceType=instance
&ResourceId.1=i-bp1j6qtvdm8w0z1o0XXX
&<Common Request Parameters>
レスポンスの例
XML
形式
<ListTagResourcesResponse>
<TagResources>
<TagResource>
<ResourceType>instance</ResourceType>
<TagValue>FinanceJoshua</TagValue>
<ResourceId>i-bp1j6qtvdm8w0z1o0XXX</ResourceId>
<TagKey>FinanceDept</TagKey>
</TagResource>
</TagResources>
<RequestId>DE65F6B7-7566-4802-9007-96F2494AC5XX</RequestId>
</ListTagResourcesResponse>
JSON
形式
{
"TagResources":{
"TagResource":[
{
"ResourceType":"instance",
"TagValue":"FinanceJoshua",
"ResourceId":"i-bp1j6qtvdm8w0z1o0XXX",
"TagKey":"FinanceDept"
}
]
},
"RequestId":"DE65F6B7-7566-4802-9007-96F2494AC512"
}
エラー
HTTP ステータスコード | エラーコード | エラーメッセージ | 説明 |
---|---|---|---|
404 | MissingParameter.TagOwnerUid | The parameter - TagOwnerUid should not be null | タグ所有者の UID が指定されていません。 |
404 | MissingParameter.TagOwnerBid | The parameter - TagOwnerBid should not be null | タグ所有者の BID が指定されていません。 |
404 | MissingParameter.ResourceType | The parameter - ResourceType should not be null | リソースタイプが指定されていません。 |
404 | MissingParameter.Tags | The parameter - Tags should not be null | タグが指定されていません。 |
404 | MissingParameter.RegionId | The parameter - RegionId should not be null | リージョン ID が指定されていません。 |
403 | PermissionDenied.TagOwnerUid | The specified operator not have permission to set TagOwnerUid value. | タグの所有者を設定する権限がありません。 |
403 | PermissionDenied.Scope | The specified operator not have permission to set Scope value. | スコープ値を変更する権限がありません。 |
400 | NumberExceed.ResourceIds | The ResourceIds parameter's number is exceed , Valid : 50 | リソース ID の数は 50 を超えることはできません。 |
400 | NumberExceed.Tags | The Tags parameter's number is exceed , Valid : 20 | タグの数は 20 を超えることはできません。 |
400 | Duplicate.TagKey | The Tag.N.Key contain duplicate key. | タグキーが重複しています。 |
404 | InvalidResourceId.NotFound | The specified ResourceIds are not found in our records. | 指定されたリソースは存在しません。 |
404 | InvalidResourceType.NotFound | The ResourceType provided does not exist in our records. | 指定されたリソースタイプは存在しません。 |
400 | InvalidTagKey.Malformed | The specified Tag.n.Key is not valid. | 指定されたタグキーは無効です。 |
400 | InvalidTagValue.Malformed | The specified Tag.n.Value is not valid. | 指定されたタグ値は無効です。 |
400 | OperationDenied.QuotaExceed | The quota of tags on resource is beyond permitted range. | リソースタグのクォータに達しました。 |
403 | InvalidResourceId.NotSupported | The specified ResourceId does not support tagging. | 指定されたリソース ID ではタグをサポートしていません。 |
400 | InvalidTag.Mismatch | The specified Tag.n.Key and Tag.n.Value are not match. | 指定された Tag.n.Key と Tag.n.Value が一致しません。 |
400 | InvalidTagCount | The specified tags are beyond the permitted range. | 指定されたタグの数がクォータを超えています。 |
404 | InvalidRegionId.NotFound | The specified RegionId does not exist. | 指定されたリージョン ID は存在しません。 このリージョンでこのプロダクトが利用可能かどうかを確認してください。 |
400 | Invalid.Scope | The specified scope is invalid. | 指定されたスコープは無効です。 |
403 | NoPermission.Tag | The operator is not permission for the tag. | このリソースタグを使用する権限がありません。 |
エラーコードのリストについては、 API エラーセンターをご覧ください。