テーブルフィールドメタデータ用 GetColumn API リファレンス - DataWorks - Alibaba Cloud - DataWorks

操作説明

DataWorks Basic Edition またはそれ以上のエディションが必要です。

今すぐお試しください

この 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:GetColumn

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Id	string	必須	ID です。`ListColumns` API のレスポンス、およびメタデータエンティティに関連する概念の説明を参照してください。形式： `${EntityType}:${インスタンス ID またはエスケープされた URL}:${カタログ識別子}:${データベース名}:${スキーマ名}:${テーブル名}:${列名}`。存在しないレベルには、プレースホルダーとして空文字列を使用します。説明 MaxCompute および DLF タイプの場合、インスタンス ID のプレースホルダーとして空文字列を使用します。MaxCompute の場合、データベース名は MaxCompute プロジェクト名を指します。プロジェクトでスキーマが有効になっている場合は、スキーマ名を指定する必要があります。それ以外の場合は、スキーマ名のプレースホルダーとして空文字列を使用します。説明 StarRocks のカタログ識別子はカタログ名であり、DLF タイプのカタログ識別子はカタログ ID です。他のタイプはカタログレベルをサポートしていません。プレースホルダーとして空文字列を使用します。一般的な ID 形式の例 `maxcompute-column:::project_name:[schema_name]:table_name:column_name` `dlf-column::catalog_id:database_name::table_name:column_name` `hms-column:instance_id::database_name::table_name:column_name` `holo-column:instance_id::database_name:schema_name:table_name:column_name` `mysql-column:(instance_id\|encoded_jdbc_url)::database_name::table_name:column_name` 説明 `instance_id` ：インスタンスの ID。データソースがインスタンスモードで登録されている場合に必要です。 `encoded_jdbc_url` ：URL エンコードされた JDBC 接続文字列。データソースが接続文字列を介して登録されている場合に必要です。 `catalog_id` ：DLF カタログ ID。 `project_name` ：MaxCompute プロジェクト名。 `database_name` ：データベース名。 `schema_name` ：スキーマ名。MaxCompute タイプの場合、プロジェクトでスキーマが有効になっている場合にのみ指定が必要です。それ以外の場合は、プレースホルダーとして空文字列を使用します。 `table_name` ：テーブル名。 `column_name` ：列名。	maxcompute-column:::project_name:[schema_name]:table_name:column_name

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンス。
RequestId	string	リクエスト ID。	D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx
Success	boolean	リクエストが成功したかどうかを示します。	true
Column	Column	テーブル内の列。

例

成功レスポンス

JSONJSON

{
  "RequestId": "D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx",
  "Success": true,
  "Column": {
    "Id": "maxcompute-column:123456::test_project:default:test_tbl:col1",
    "Name": "col1",
    "Comment": "字段1",
    "TableId": "maxcompute-table:123456::test_project:default:test_tbl",
    "Position": 1,
    "Type": "bigint",
    "PrimaryKey": false,
    "PartitionKey": false,
    "ForeignKey": false,
    "BusinessMetadata": {
      "Description": "字段1的业务描述",
      "CustomAttributes": {
        "key": [
          "张三"
        ]
      }
    }
  }
}

エラーコード

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

変更履歴

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