Data Map カタログ用 GetCatalog API リファレンス - DataWorks

操作説明

DataWorks のベーシック版以上をご購入済みである必要があります。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dataworks:GetCatalog

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Id	string	必須	カタログエンティティの ID。現在は dlf および starrocks のタイプがサポートされています。詳細については、「ListCatalogs」操作の戻り値および「メタデータエンティティに関する概念」をご参照ください。 DLF タイプの場合、フォーマットは `dlf-catalog::catalog_id` です。 StarRocks タイプの場合、フォーマットは `starrocks-catalog:(instance_id\|encoded_jdbc_url):catalog_name` です。説明 `catalog_id`：DLF カタログの ID。 `instance_id`：インスタンス ID。データソースをインスタンスモードで登録した場合に必須です。 `encoded_jdbc_url`：URL エンコードされた JDBC 接続文字列。データソースを接続文字列モードで登録した場合に必須です。 `catalog_name`：StarRocks カタログの名前。	dlf-catalog::catalog_id

レスポンスフィールド

フィールド	型	説明	例
	object	応答内容。
RequestId	string	リクエスト ID。	1AFAE64E-D1BE-432B-A9****
Success	boolean	リクエストが成功したかどうかを示します。	true
Catalog	Catalog	カタログの情報。

例

成功レスポンス

JSONJSON

{
  "RequestId": "1AFAE64E-D1BE-432B-A9****",
  "Success": true,
  "Catalog": {
    "Id": "dlf-catalog:123456XXX:test_catalog\nstarrocks-catalog:c-abc123xxx:default_catalog",
    "Name": "default_catalog",
    "Comment": "this is a comment\n",
    "Type": "Internal",
    "CreateTime": 1722073854000,
    "ModifyTime": 1722073854000,
    "ParentMetaEntityId": "dlf\nstarrocks:c-abc123xxx"
  }
}

エラーコード

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

変更履歴

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