フィールド情報を含むテーブルの完全な情報を取得します。
この API は、代替案なしで廃止されました。一時的にアクセス可能ですが、更新やバグ修正対応は一切行われません。継続的な機能を確保するため、移行を計画し、アカウントマネージャーにお問い合わせください。
操作説明
EMR エンジンタイプのテーブルのみがサポートされています。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| TableGuid |
string |
任意 |
テーブルのグローバル一意識別子 (GUID)。 GetMetaDBTableList を呼び出してテーブルの GUID を取得できます。 |
odps.engine_name.table_name |
| PageNum |
integer |
任意 |
ページネーションのページ番号。 |
1 |
| PageSize |
integer |
任意 |
1 ページあたりのエントリ数。デフォルト値: 10。最大値: 100。 |
10 |
| ClusterId |
string |
任意 |
EMR クラスターの ID。このパラメーターは、データソースタイプが EMR の場合にのみ必須です。 EMR コンソール にログインしてクラスター ID を取得できます。 |
C-010A704DA760**** |
| DatabaseName |
string |
任意 |
データベースの名前。このパラメーターは、データソースタイプが EMR の場合にのみ必須です。 ListMetaDB 操作を呼び出してデータベース名を取得できます。 |
abc |
| TableName |
string |
任意 |
EMR テーブルの名前。このパラメーターは、データソースタイプが EMR の場合にのみ必須です。 GetMetaDBTableList 操作を呼び出してテーブル名を取得できます。 |
abc |
| DataSourceType |
string |
任意 |
データソースタイプ。現在、EMR のみがサポートされています。 |
emr |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンス構造体。 |
||
| HttpStatusCode |
integer |
HTTP 状態コード。 |
200 |
| ErrorMessage |
string |
エラーメッセージ。 |
指定されたパラメーターは有効ではありません。 |
| RequestId |
string |
リクエスト ID。この ID を使用してログを特定し、問題のトラブルシューティングを行えます。 |
0bc1411515937**** |
| Success |
boolean |
呼び出しが成功したかどうかを示します。 |
true |
| ErrorCode |
string |
エラーコード。 |
1031203110005 |
| Data |
object |
ビジネスデータ。 |
|
| TableName |
string |
テーブルの名前。 |
table_name |
| Comment |
string |
テーブルのコメント。 |
コメント |
| LifeCycle |
integer |
テーブルのライフサイクル (日数)。 |
5 |
| CreateTime |
integer |
テーブルが作成された時間。値はタイムスタンプです。タイムスタンプは、使用しているタイムゾーンに基づいて日付に変換できます。 |
1589870293000 |
| ProjectName |
string |
テーブルが属するワークスペースの名前。 |
test |
| ProjectId |
integer |
テーブルが属するワークスペースの ID。 |
22 |
| OwnerId |
string |
テーブルオーナーの ID。 |
123 |
| EnvType |
integer |
環境タイプ。有効な値:
|
1 |
| LastAccessTime |
integer |
テーブルに最後にアクセスした時間。値はタイムスタンプです。タイムスタンプは、使用しているタイムゾーンに基づいて日付に変換できます。 |
1589870294000 |
| DataSize |
integer |
テーブルが占有するストレージ領域 (バイト単位)。 |
10 |
| LastModifyTime |
integer |
テーブルが最後に更新された時間。値はタイムスタンプです。タイムスタンプは、使用しているタイムゾーンに基づいて日付に変換できます。 |
1589870294000 |
| DatabaseName |
string |
データベースの名前。 |
abc |
| IsVisible |
integer |
テーブルの可視性。有効な値:
|
1 |
| TotalColumnCount |
integer |
フィールドの総数。 |
22 |
| TableGuid |
string |
テーブルの GUID。 |
odps.engine_name.table_name |
| PartitionKeys |
string |
パーティションキー。 |
abc |
| LastDdlTime |
integer |
テーブルスキーマが最後に変更された時間。値はタイムスタンプです。タイムスタンプは、使用しているタイムゾーンに基づいて日付に変換できます。 |
1589870294000 |
| Location |
string |
Hive テーブルのストレージパス。 |
hdfs://localhost:777/user/hadoop/test.txt |
| ClusterId |
string |
EMR クラスターの ID。 |
C-010A704DA760**** |
| TenantId |
integer |
テナント ID。 |
12345 |
| Schema |
string |
テーブルのスキーマ情報。 |
デフォルト |
| ColumnList |
array<object> |
フィールドのリスト。 |
|
|
object |
レスポンス構造体。 |
||
| ColumnName |
string |
フィールドの名前。 |
1 |
| ColumnGuid |
string |
フィールドの GUID。 |
odps.engine_name.table_name.1 |
| IsPartitionColumn |
boolean |
フィールドがパーティションフィールドかどうかを示します。有効な値:
|
true |
| Comment |
string |
フィールドのコメント。 |
コメント |
| ColumnType |
string |
フィールドのタイプ。 |
string |
| IsPrimaryKey |
boolean |
フィールドがプライマリキーかどうかを示します。有効な値:
|
false |
| Position |
integer |
フィールドの順序位置。 |
1 |
| Caption |
string |
フィールドの説明。 |
データのコメント |
| IsForeignKey |
boolean |
フィールドが外部キーかどうかを示します。有効な値:
|
true |
例
成功レスポンス
JSONJSON
{
"HttpStatusCode": 200,
"ErrorMessage": "The specified parameters are invalid.",
"RequestId": "0bc1411515937****",
"Success": true,
"ErrorCode": "1031203110005",
"Data": {
"TableName": "table_name",
"Comment": "comment",
"LifeCycle": 5,
"CreateTime": 1589870293000,
"ProjectName": "test",
"ProjectId": 22,
"OwnerId": "123",
"EnvType": 1,
"LastAccessTime": 1589870294000,
"DataSize": 10,
"LastModifyTime": 1589870294000,
"DatabaseName": "abc",
"IsVisible": 1,
"TotalColumnCount": 22,
"TableGuid": "odps.engine_name.table_name",
"PartitionKeys": "abc",
"LastDdlTime": 1589870294000,
"Location": "hdfs://localhost:777/user/hadoop/test.txt",
"ClusterId": "C-010A704DA760****",
"TenantId": 12345,
"Schema": "default",
"ColumnList": [
{
"ColumnName": "1",
"ColumnGuid": "odps.engine_name.table_name.1",
"IsPartitionColumn": true,
"Comment": "comment",
"ColumnType": "string",
"IsPrimaryKey": false,
"Position": 1,
"Caption": "data comment",
"IsForeignKey": true
}
]
}
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidParameter.Meta.CommonError | The specified parameter is invalid. | リクエストパラメーターが無効です。 |
| 400 | InvalidParameter.Meta.Illegal | The app guid parameter is invalid. | App パラメーターが無効です。 |
| 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. | |
| 400 | InternalError.Meta.NoCalcEngine | An error occurred while retrieving the compute engine based on the MaxCompute project. | 指定したプロジェクトが正しくありません。 |
| 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.TenantTimeOut | Failed to connect to the interface network. | API ネットワークが到達不能です。 |
| 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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。