ListTagResources - - Alibaba Cloud ドキュメントセンター

1 つ以上の PolarDB クラスターにアタッチされているタグ、または 1 つ以上のタグにアタッチされている PolarDB クラスターをクエリします。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardb:ListTagResources

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:{#resource-type}/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。 DescribeRegions 操作を呼び出して、利用可能なリージョン ID を表示できます。	cn-hangzhou
ResourceType	string	必須	リソースタイプ。値を cluster に設定します。	cluster
NextToken	string	任意	次の結果ページを取得するためのトークン。最初のリクエストでは、このパラメーターを指定する必要はありません。最初のリクエストですべての結果が返されない場合、応答はトークンを返します。このトークンを次のリクエストで使用して、クエリを続行できます。	212db86sca4384811e0b5e8707*******
ResourceId	array	任意	クラスターの ID。複数のクラスター ID を指定して、複数のクラスターのタグをクエリできます。説明 `ResourceId.N` パラメーターまたは `Tag.N.Key` パラメーターのいずれかを指定する必要があります。 `ResourceId.N` パラメーターを指定する場合、最大 50 個のクラスター ID を追加できます。	pc-****************
	string	任意	クラスターの ID。複数のクラスター ID を指定して、複数のクラスターのタグをクエリできます。説明 `ResourceId.N` パラメーターまたは `Tag.N.Key` パラメーターのいずれかを指定する必要があります。 `ResourceId.N` パラメーターを指定する場合、最大 50 個のクラスター ID を追加できます。	pc-****************
Tag	array<object>	任意	タグのリスト。
	object	任意
Key	string	任意	タグのキー。複数のタグを指定して、指定されたすべてのタグを持つリソースをクエリできます。説明 `ResourceId.N` パラメーターまたは `Tag.N.Key` パラメーターのいずれかを指定する必要があります。 `Tag.N.Key` パラメーターを指定する場合、最大 20 個のタグペアを追加できます。	type
Value	string	任意	タグキーに対応するタグ値。空の文字列が許可されます。	test

レスポンスフィールド

フィールド	型	説明	例
	object
NextToken	string	より多くの結果を取得するためのトークン。このパラメーターは、クエリがすべての結果を返さない場合に返されます。後続のクエリでトークンを使用して、結果の取得を続行できます。	212db86sca4384811e0b5e8707e******
RequestId	string	リクエスト ID。	688C04E4-23F8-409F-8A38-B954D5******
TagResources	object
TagResource	array<object>	クエリされたクラスターとタグに関する情報。
	object
ResourceType	string	リソースタイプ。値は cluster です。	cluster
TagValue	string	タグキーに対応するタグ値。	test
ResourceId	string	クラスター ID。	pc-****************
TagKey	string	タグキー。	type

例

成功レスポンス

JSONJSON

{
  "NextToken": "212db86sca4384811e0b5e8707e******",
  "RequestId": "688C04E4-23F8-409F-8A38-B954D5******",
  "TagResources": {
    "TagResource": [
      {
        "ResourceType": "cluster",
        "TagValue": "test",
        "ResourceId": "pc-****************",
        "TagKey": "type"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	NumberExceed.Tags	The Tags parameter`s number is exceed.
400	MissParameter.TagOrResourceId	The parameter Tag.n or ResourceId.n is needed.
400	NumberExceed.ResourceIds	The ResourceIds parameter's number is exceed.
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。