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

:ListCatalogs

最終更新日:Jan 13, 2026

データカタログのリストを表示します

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

emr-serverless-spark:ListCatalogs

list

*All Resource

*

なし なし

リクエスト構文

GET /api/v1/workspaces/{workspaceId}/catalogs HTTP/1.1

パスパラメータ

パラメーター

必須 / 任意

説明

workspaceId

string

任意

ワークスペース ID。

w-d2d82aa09155****

リクエストパラメーター

パラメーター

必須 / 任意

説明

environment

string

任意

環境タイプ。

列挙値:

  • dev :

    dev

  • production :

    production

dev

regionId

string

任意

リージョン ID。

cn-hangzhou

レスポンスフィールド

フィールド

説明

object

返されるデータ。

catalogs

array<object>

データカタログ。

array<object>

データカタログ。

catalogId

string

データカタログの ID。

15097**********

workspaceId

string

ワークスペース ID。

w-d2d82aa09155****

environments

array

環境タイプ。

string

環境タイプ。

dev,production

catalogType

string

これがデフォルトのデータカタログであるかどうかを示します。

default_catalog

catalogProvider

string

データカタログのプロバイダー。

HMS

gmtCreate

integer

リソースが作成された時間。

1760604889

gmtModified

integer

リソースが最後に更新された時間。

1760604889

resourceOwnerId

string

リソース所有者の ID。

15097**********

alias

string

alias

extras

object

追加情報。

string

追加情報。

{"networkName":"hms","metastoreUrl":"thrift://master-1-1.c-70*********.cn-hangzhou.emr.aliyuncs.com:9083","keytabPath":"oss://********/hive.keytab","principal":"hive/master-1-1.c-70****************"}

requestId

string

リクエスト ID。

DD6B1B2A-5837-5237-ABE4-FF0C8944****

nextToken

string

次のページの結果を取得するためのトークン。

1

totalCount

integer

エントリの総数。

200

maxResults

integer

各ページで返されるエントリの最大数。

20

成功レスポンス

JSONJSON

{
  "catalogs": [
    {
      "catalogId": "15097**********",
      "workspaceId": "w-d2d82aa09155****\n",
      "environments": [
        "dev,production"
      ],
      "catalogType": "default_catalog",
      "catalogProvider": "HMS",
      "gmtCreate": 1760604889,
      "gmtModified": 1760604889,
      "resourceOwnerId": "15097**********",
      "alias": "alias",
      "extras": {
        "key": "{\"networkName\":\"hms\",\"metastoreUrl\":\"thrift://master-1-1.c-70*********.cn-hangzhou.emr.aliyuncs.com:9083\",\"keytabPath\":\"oss://********/hive.keytab\",\"principal\":\"hive/master-1-1.c-70****************\"}"
      }
    }
  ],
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "nextToken": "1",
  "totalCount": 200,
  "maxResults": 20
}

エラーコード

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

変更履歴

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