Cloud Enterprise Network (CEN) インスタンスに追加されたタグを照会します。
使用上の注意
この操作を呼び出すには、ResourceId.NとTag.N.Keyの少なくとも1つを設定する必要があります。
- ResourceId.Nのみを設定した場合、指定されたCENインスタンスに追加されたタグが返されます。
- Tag.N.Keyのみを設定した場合、指定されたタグを持つCENインスタンスが返されます。
- ResourceId.NとTag.N.Keyの両方を設定した場合、指定されたCENインスタンスに追加された指定されたタグが返されます。
- ResourceId.Nで指定されたCENインスタンスに、tag. N.Keyで指定されたタグがあることを確認します。 それ以外の場合、応答はnullを返します。
- 複数のタグキーを指定した場合, これらのタグキーの論理演算子はANDとなります。
デバッグ
リクエストパラメーター
パラメーター | データ型 | 必須/任意 | 例 | 説明 |
---|---|---|---|---|
操作 | String | 必須 | ListTagResources |
実行する操作です。 値をListTagResourcesに設定します。 |
ResourceType | String | 必須 | cen |
リソースのタイプを示します。 値をcenに設定します。これはCENインスタンスを指定します。 |
NextToken | String | 任意 | FFmyTO70tTpLG6I3FmYAXGKPd **** |
次のクエリに使用されるトークン。 設定可能な値は以下のとおりです。
|
PageSize | Integer | 任意 | 10 |
各ページで返されるエントリ数。 有効な値: 1〜50。 デフォルト値: 10 |
ResourceId.N | String | 任意 | cen-8z69wtwqel33lq **** |
CENインスタンスのID。 各呼び出しで最大20個のIDを指定できます。 |
Tag.N.Key | String | 任意 | test |
タグのキー。 キーの長さは64文字を超えることはできません。また、 最大20個のタグキーを指定できます。 |
Tag.N.Value | String | 任意 | Bp |
タグの値。 値の長さは128文字を超えることはできません。また、 最大20個のタグ値を指定できます。 |
レスポンスパラメーター
パラメーター | データ型 | 例 | 説明 |
---|---|---|---|
NextToken | String | FFmyTO70tTpLG6I3FmYAXGKPd **** |
次のクエリに使用されるトークン。 設定可能な値は以下のとおりです。
|
RequestId | String | 165B5C86-2033-5954-A89D-4CD83BA06C85 |
リクエストの ID です。 |
TagResources | TagResourceの配列 |
リソースとタグ。 |
|
TagResource | |||
ResourceType | String | CEN |
リソースのタイプを示します。 値はcenで、CENインスタンスを指定します。 |
TagValue | String | Bp |
タグの値。 |
ResourceId | String | cen-8z69wtwqel33lq **** |
CEN インスタンスの ID。 |
TagKey | String | test |
タグの値。 |
例
リクエストの例
http(s)://[Endpoint]/?Action=ListTagResources
&ResourceType=cen
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd ****
&PageSize=10
&ResourceId=["cen-8z69wtwqel33lq ****"]
&タグ=[{"Key":"test","Value":"Bp"}]
&<共通リクエストパラメーター>
正常に処理された場合のレスポンス例
XML
形式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListTagResourcesResponse>
<NextToken>FFmyTO70tTpLG6I3FmYAXGKPd ****</NextToken>
<RequestId>165B5C86-2033-5954-A89D-4CD83BA06C85</RequestId>
<TagResources>
<ResourceType>CEN</ResourceType>
<TagValue>Bp</TagValue>
<ResourceId>cen-8z69wtwqel33lq ****</ResourceId>
<TagKey>test</TagKey>
</TagResources>
</ListTagResourcesResponse>
JSON
形式
HTTP/1.1 200 OK
Content-Type:application/json
{
"NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd ****" 、
"RequestId" : "165B5C86-2033-5954-A89D-4CD83BA06C85" 、
"TagResources" : [ {
"ResourceType" : "CEN" 、
"TagValue" : "Bp" 、
"ResourceId" : "cen-8z69wtwqel33lq ****" 、
"TagKey" : "テスト"
} ]
}
エラーコード
HttpCode | エラーコード | エラーメッセージ | 説明 |
---|---|---|---|
400 | InvalidTagKey | タグキーは無効です。 | 指定されたタグキーが無効な場合に表示されるエラーメッセージ。 |
400 | IllegalParam.NextToken | パラメーターNextTokenが無効です。 | NextTokenが無効な値に設定されている場合に返されるエラーメッセージ。 有効な値を指定して、もう一度お試しください。 |
エラーコードリストについては、「API エラーセンター」をご参照ください。