ListResourcesByAdvancedSearch を使用した SQL によるリソースのクエリ - Cloud Config

操作説明

`SELECT` 文を作成する際、リソースタイプのプロパティファイルからフィールドとそのデータの型を取得する必要があります。プロパティファイルの詳細については、「Alibaba Cloud Config Resource Schema」をご参照ください。

説明

Cloud Config でサポートされている各リソースタイプには、プロパティファイルがあります。プロパティファイルは、関連するリソースタイプに基づいて命名されます。たとえば、リソースタイプ `ACS::ECS::Instance` のプロパティファイル名は `ACS_ECS_Instance.properties.json` です。異なるリソースタイプのプロパティファイルは、`config/properties/resource-types` パスに配置されます。
SQL クエリ文の例と制限事項の詳細については、「SQL クエリ文の例」および「SQL クエリ文の制限事項」をご参照ください。

このトピックでは、詳細検索機能を使用して、現在のアカウント内でタグキーが `business` で、タグ値が `online` であるすべてのリソースを取得する方法の例を示します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

config:ListResourcesByAdvancedSearch

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Sql	string	必須	SQL クエリ文。	SELECT ResourceId, ResourceName WHERE Tags.Kvpair='business:online'

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	D241DEBF-67A2-56AF-88CF-57BF78F0A850
QueryResults	object	クエリ結果。
QueryResultList	object	クエリされたリソース。最大 1,000 件のデータレコードを返すことができます。より多くのデータを表示するには、リソースファイルのダウンロード URL を使用してください。
Columns	array	フィールド名。
	string	フィールド名。	["ResourceId", "ResourceName"]
Values	array	リソースデータ。
	any	リソースデータ。	["eni-2ze5lq7xaluy5kb5****", "test-resource"]

例

成功レスポンス

JSONJSON

{
  "RequestId": "D241DEBF-67A2-56AF-88CF-57BF78F0A850",
  "QueryResults": {
    "QueryResultList": {
      "Columns": [
        "[\"ResourceId\", \"ResourceName\"]"
      ],
      "Values": [
        "[\"eni-2ze5lq7xaluy5kb5****\", \"test-resource\"]"
      ]
    }
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
404	AccountNotExisted	Your account does not exist.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.

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

変更履歴

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