すべてのプロダクト
Search
ドキュメントセンター

ApsaraDB for MongoDB:DescribeTags

最終更新日:Dec 18, 2025

指定されたリージョン内のすべてのタグをクエリします。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dds:DescribeTags

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

必須

インスタンスのリージョン ID。DescribeRegions 操作を呼び出して、最新のリージョンリストをクエリできます。

cn-hangzhou

ResourceType

string

任意

リソースタイプ。値を INSTANCE に設定します。

INSTANCE

ResourceGroupId

string

任意

リソースグループの ID。

dds-bp17e7a04960****

NextToken

string

任意

より多くの結果を取得するために次のクエリを開始するためのトークンです。

説明

このパラメーターは、最初のクエリでは必須ではありません。1 回のクエリですべての結果が返されない場合は、前のクエリで返された NextToken 値を渡してクエリを再度実行できます。

212db86****

レスポンスフィールド

フィールド

説明

object

NextToken

string

次のクエリを開始するためのトークンです。

説明

最初のクエリですべての結果が返されない場合、このパラメーターが返されます。次のクエリでこのパラメーターの値を渡すことができます。

212db86****

RequestId

string

リクエストの ID。

EEDBE38F-5CF5-4316-AAC2-35817BA60D68

Tags

array<object>

タグの詳細。

object

TagValues

array

タグの値。

string

タグの値。

3.4环境

TagKey

string

タグのキー。

测试组

成功レスポンス

JSONJSON

{
  "NextToken": "212db86****",
  "RequestId": "EEDBE38F-5CF5-4316-AAC2-35817BA60D68",
  "Tags": [
    {
      "TagValues": [
        "3.4环境"
      ],
      "TagKey": "测试组"
    }
  ]
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 InvalidTagKey.Malformed The specified parameter 'Tag.n.Key' or 'TagKey.n' is not valid.
400 InvalidTagValue.Malformed The specified parameter 'Tag.n.Value' is not valid.
400 InvalidParameter.ResourceId The specified parameter 'ResourceId.n' is not valid.
400 MissParameter.TagOrResourceId The parameter 'Tag.n'' or 'ResourceId.n' is needed.
400 InvalidParameter.Scope The specified parameter 'Scope' is not valid.
400 NumberExceed.ResourceIds The ResourceIds parameter's number is exceed.
400 NumberExceed.Tags The Tags parameter's number is exceed.
400 Duplicate.TagKey The specified parameter 'Tag.n.Key' is duplicated.
400 InvalidParameter.ResourceType The specified parameter 'ResourceType' is not valid.
404 InvalidDbInstanceId.NotFound Specified instance does not exist.

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

変更履歴

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