該介面用於根據條件搜尋表。
介面說明
僅支援搜尋 MaxCompute 和 EMR 兩種類型的引擎表。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| PageNumber |
integer |
否 |
分頁查詢頁碼。 |
1 |
| PageSize |
integer |
否 |
每頁顯示的條數，預設為 10 條，最大 100 條。 |
10 |
| AppGuid |
string |
否 |
表所在工作空間的標識。 |
odps.engine_name |
| Keyword |
string |
是 |
關鍵字採用分詞匹配演算法搜尋表名，如果沒有匹配的欄位則返回空值。預設按照底線分詞搜尋。 |
test |
| EntityType |
integer |
否 |
表的類型：0 表示 table，1 表示 view。如果不填，則預設搜尋全部類型。 |
0 |
| ClusterId |
string |
否 |
EMR 叢集的 ID，僅當資料類型為 EMR 時，需要配置該參數。 您可以登入 EMR 的控制台，擷取叢集 ID。 |
abc |
| DataSourceType |
string |
否 |
資料類型，包括 ODPS 和 emr。 |
emr |
| Schema |
string |
否 |
表 Schema 資訊。在 ODPS，使用者啟動了三層模型需要填寫 Schema 資訊 |
default |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回結果。 |
||
| HttpStatusCode |
integer |
請求返回碼。 |
200 |
| ErrorMessage |
string |
錯誤資訊。 |
The specified parameters are invalid. |
| RequestId |
string |
請求 ID。 |
0bc1ec92159376**** |
| Success |
boolean |
請求是否成功。 |
true |
| ErrorCode |
string |
錯誤碼。 |
1031203110005 |
| Data |
object |
搜尋結果。 |
|
| PageNumber |
integer |
分頁查詢頁碼。 |
1 |
| PageSize |
integer |
分頁查詢每頁的大小。 |
10 |
| TotalCount |
integer |
表的總數。 |
100 |
| DataEntityList |
array<object> |
查詢返回的表列表。 |
|
|
object |
表詳情。 |
||
| TableName |
string |
表的名稱。 |
test_name |
| DatabaseName |
string |
資料庫名稱。 |
abc |
| EntityType |
integer |
表的類型：
|
0 |
| ProjectName |
string |
工作空間的名稱。 |
test |
| ProjectId |
integer |
工作空間的 ID。 |
323 |
| TableGuid |
string |
表的唯一標識。 |
odps.engine_name.test_name |
| OwnerId |
string |
工作空間 Owner 的雲帳號 ID。 |
123 |
| ClusterId |
string |
EMR 叢集 ID。 |
abc |
| EnvType |
integer |
環境類型：
|
1 |
| TenantId |
integer |
租戶 ID。 |
12345 |
| Schema |
string |
表 Schema 資訊。在 ODPS，使用者啟動了三層模型需要填寫 Schema 資訊 |
default |
樣本
正常返回樣本
JSON格式
{
"HttpStatusCode": 200,
"ErrorMessage": "The specified parameters are invalid.",
"RequestId": "0bc1ec92159376****",
"Success": true,
"ErrorCode": "1031203110005",
"Data": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 100,
"DataEntityList": [
{
"TableName": "test_name",
"DatabaseName": "abc",
"EntityType": 0,
"ProjectName": "test",
"ProjectId": 323,
"TableGuid": "odps.engine_name.test_name",
"OwnerId": "123",
"ClusterId": "abc",
"EnvType": 1,
"TenantId": 12345,
"Schema": "default"
}
]
}
}錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | Invalid.Meta.TableNotExist | The table does not exist. | 表不存在。 |
| 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.UserId.Missing | An internal system error occurred. Try again later. | |
| 400 | InternalError.Meta.NoCalcEngine | An error occurred while retrieving the compute engine based on the MaxCompute project. | 使用者輸入的 project 不正確 |
| 500 | InternalError.System | An internal system error occurred. Try again later. | |
| 500 | InternalError.Meta.TenantTimeOut | Failed to connect to the interface network. | 介面網路不通。 |
| 500 | InternalError.Meta.Unknown | An unknown error occurred while processing your request. | 未知錯誤。 |
| 403 | ResourceNotAuthorized.Api | You are not authorized to access the resources. | |
| 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. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。