Express Connect 回線に付与されたタグをクエリします。
操作説明
特定のオブジェクトをクエリする場合は、リクエストで ResourceId.N または Tag.N.Key と Tag.N.Value で構成される Tag.N を指定する必要があります。
Tag.N はキーと値のペアで構成されるリソースタグです。Tag.N.Key のみを指定した場合、指定されたキーに関連付けられたすべてのタグ値が返されます。Tag.N.Value のみを指定した場合、エラーメッセージが返されます。
Tag.N と ResourceId.N を指定してタグをフィルターする場合、ResourceId.N は指定されたすべてのキーと値のペアに一致する必要があります。
複数のキーと値のペアを指定した場合、これらのキーと値のペアを含むリソースが返されます。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ResourceType |
string |
必須 |
リソースのタイプ。有効な値：
|
PHYSICALCONNECTION |
| RegionId |
string |
必須 |
リソースが存在するリージョンの ID。 DescribeRegions 操作を呼び出して、リージョン ID を取得できます。 |
cn-hangzhou |
| NextToken |
string |
任意 |
次のリクエストで新しいページの結果を取得するために使用するページネーショントークン。
|
FFmyTO70tTpLG6I3FmYAXGKPd**** |
| MaxResults |
integer |
任意 |
1 ページあたりのエントリ数。有効な値：1 ～ 100。デフォルト値：20。 |
20 |
| ResourceId |
array |
任意 |
リソース ID。 |
|
|
string |
任意 |
リソース ID。最大 20 個のリソース ID を指定できます。 |
pc-bp16qjewdsunr41m1**** |
|
| Tag |
array<object> |
任意 |
タグ。 |
|
|
object |
任意 |
|||
| Key |
string |
任意 |
リソースに追加するタグのキー。最大 20 個のタグキーを指定できます。タグキーは空文字列にできません。 タグキーの長さは最大 128 文字で、 |
FinanceDept |
| Value |
string |
任意 |
リソースに追加するタグの値。最大 20 個のタグ値を指定できます。タグ値は空文字列にできます。 タグ値の長さは最大 128 文字で、 |
FinanceJoshua |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| NextToken |
string |
ページネーショントークン。次のリクエストで新しいページの結果を取得するために使用できます。
|
FFmyTO70tTpLG6I3FmYAXGKPd**** |
| RequestId |
string |
リクエスト ID。 |
54B48E3D-DF70-471B-AA93-08E683A1B45 |
| TagResources |
object |
||
| TagResource |
array<object> |
リソースに追加されたタグ。 |
|
|
object |
|||
| ResourceType |
string |
リソースのタイプ。有効な値：
|
PHYSICALCONNECTION |
| TagValue |
string |
リソースに追加されたタグの値。 |
FinanceJoshua |
| ResourceId |
string |
リソース ID。 |
pc-bp16qjewdsunr41m1**** |
| TagKey |
string |
リソースに追加されたタグのキー。 |
FinanceDept |
例
成功レスポンス
JSONJSON
{
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
"TagResources": {
"TagResource": [
{
"ResourceType": "PHYSICALCONNECTION",
"TagValue": "FinanceJoshua",
"ResourceId": "pc-bp16qjewdsunr41m1****",
"TagKey": "FinanceDept"
}
]
}
}エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidTagKey | The tag keys are not valid. | |
| 400 | InvalidTagValue | The tag values are not valid. | |
| 400 | InvalidInstanceType.NotFound | The instance type is not found | |
| 400 | InvalidInstanceIds.NotFound | The instanceIds are not found | |
| 400 | Forbidden.TagKeys | The request do not allow to operate the tag keys | |
| 400 | QuotaExceeded.TagNum | Custom Tags quota exceeded | |
| 400 | Forbidden.TagKey.Duplicated | The specified tag key already exists. | |
| 400 | SizeLimitExceeded.TagNum | The maximum number of tags is exceeded. | |
| 400 | SizeLimitExceeded.ResourceId | The maximum number of resource IDs is exceeded. | |
| 403 | Forbidden | User not authorized to operate on the specified resource. | |
| 403 | BothEmpty.TagsAndResources | The specified Tags and ResourcesIds are not allow to both empty. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。