GetMetaTableIntroWiki を使用してテーブル説明を取得する - DataWorks - Alibaba Cloud - 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:*

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
TableGuid	string	必須	テーブルの一意な識別子。	odps.engine_name.table_name
WikiVersion	integer	任意	使用量説明のバージョン。	1

レスポンスフィールド

フィールド	型	説明	例
	object
HttpStatusCode	integer	HTTP 状態コード。	200
ErrorMessage	string	エラーメッセージ。	接続が存在しません
RequestId	string	リクエスト ID。	0bc1ec92159376
Success	boolean	リクエストが成功したかどうかを示します。	true
ErrorCode	string	エラーコード。	Invalid.Tenant.ConnectionNotExists
Data	object	ビジネスデータ。
ModifiedTime	integer	テーブルが変更済みの時間。値は `1584444247000` のような 13 桁の数値です。	1584444247000
Version	integer	バージョン番号。	1
CreateTime	integer	テーブルが作成された時間。値は `1584444247000` のような 13 桁の数値です。	1584444247000
CreatorName	string	テーブル作成者の名前。	abc
Content	string	テーブルの説明。	# ビジネス要件\n\n<a name="xiw5n"
Creator	string	テーブルの作成者。	abc

例

成功レスポンス

JSONJSON

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0bc1ec92159376",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Data": {
    "ModifiedTime": 1584444247000,
    "Version": 1,
    "CreateTime": 1584444247000,
    "CreatorName": "abc",
    "Content": "# Business requirements\\n\\n<a name="xiw5n"",
    "Creator": "abc"
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidParameter.Meta.CommonError	The specified parameter is invalid.
400	InvalidParameter.Meta.Illegal	The app guid parameter is invalid.
400	InvalidParameter.Meta.IllegalDate	The date format is invalid.
400	InvalidParameter.Meta.IllegalPageError	The parameter for paging is invalid.
400	InvalidParameter.Meta.NotExist	The object does not exist.
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
500	InternalError.Meta.NoCalcEngine	An error occurred while retrieving the compute engine based on the MaxCompute project.
500	InternalError.Meta.TenantTimeOut	Failed to connect to the interface network.
500	InternalError.Meta.Unknown	An unknown error occurred while processing your request.
403	Forbidden.Meta.NoTenant	The user is not the owner of any tenants.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.Api.Risk	The request for this resource has exceeded your daily available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

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

変更履歴

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