データベースメタデータ概要 & GetDatabase API リファレンス - DataWorks

操作説明

この機能を使用するには、DataWorks ベーシック版以降をご購入いただく必要があります。

今すぐお試しください

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

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Id	string	必須	データベースエンティティの ID。 ListDatabases 操作の応答およびメタデータエンティティ関連の概念をご参照ください。フォーマット： `${EntityType}:${インスタンス ID またはエスケープされた URL}:${カタログ識別子}:${データベース名}`。存在しないレベルには、プレースホルダーとして空の文字列を使用します。説明 StarRocks の場合、カタログ識別子はカタログ名です。 DLF の場合、カタログ識別子はカタログ ID です。他のタイプの場合、カタログレベルの階層はサポートされておらず、プレースホルダーとして空の文字列を使用できます。一般的な ID フォーマットの例 `dlf-database::catalog_id:database_name` `holo-database:instance_id::database_name` `mysql-database:(instance_id\|encoded_jdbc_url)::database_name` 説明 `catalog_id`： DLF カタログの ID。 `instance_id`：インスタンス ID。データソースがインスタンスモードで登録されている場合に必要です。 `encoded_jdbc_url`：エンコードされた JDBC 接続文字列。データソースが接続文字列モードで登録されている場合に必要です。 `database_name`：データベース名。	dlf-database::catalog_id:database_name

レスポンスフィールド

フィールド	型	説明	例
	object	応答。
RequestId	string	リクエスト ID。	1AFAE64E-D1BE-432B-A9****
Success	boolean	リクエストが成功したかどうかを示します。	true
Database	Database	データベースの詳細。

例

成功レスポンス

JSONJSON

{
  "RequestId": "1AFAE64E-D1BE-432B-A9****",
  "Success": true,
  "Database": {
    "Id": "holo-database:h-xxxx::test_db",
    "Name": "test_db",
    "Comment": "test comment",
    "LocationUri": "oss://test-bucket/test_db",
    "ParentMetaEntityId": "holo:h-xxxx",
    "CreateTime": 1736852168000,
    "ModifyTime": 1736852168000
  }
}

エラーコード

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

変更履歴

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