Queries table levels. This API operation will be replaced soon. We recommend that you do not call this API operation.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ListTableLevel |
The operation that you want to perform. |
LevelType | Integer | Yes | 1 |
The type of the table level. Valid values: 1 and 2. A value of 1 indicates the logical level. A value of 2 indicates the physical level. |
ProjectId | Long | Yes | 123 |
The ID of the DataWorks workspace. You can log on to the DataWorks console to obtain the ID. |
RegionId | String | Yes | cn-shanghai |
The ID of the region where the service is activated. For example, the ID of the China (Shanghai) region is cn-shanghai, and that of the China (Zhangjiakou) region is cn-zhangjiakou. The system automatically determines the value of this parameter based on the endpoint used to call the operation. |
PageNum | Integer | No | 1 |
The number of the page to return. Default value: 1. |
PageSize | Integer | No | 10 |
The number of entries to return on each page. Default value: 10. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
ErrorCode | String | 1031203110005 |
The error code returned. |
ErrorMessage | String | The specified parameters are invalid. |
The error message returned. |
HttpStatusCode | Integer | 200 |
The HTTP status code returned. |
RequestId | String | abc |
The ID of the request. |
Success | Boolean | true |
Indicates whether the request is successful. |
TableLevelInfo | Struct |
The information about the table levels. |
|
LevelList | Array of LevelList |
The list of table levels. |
|
Description | String | Description of table level |
The description of the table level. |
LevelId | Long | 123 |
The ID of the table level. |
LevelType | Integer | 1 |
The type of the table level. Valid values: 1 and 2. A value of 1 indicates the logical level. A value of 2 indicates the physical level. |
Name | String | Level 1 |
The name of the table level. |
ProjectId | Long | 123 |
The ID of the DataWorks workspace. |
TotalCount | Long | 10 |
The total number of table levels returned. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=ListTableLevel
&LevelType=1
&ProjectId=123
&RegionId=cn-shanghai
&<Common request parameters>
Sample success responses
XML
format
<TableLevelInfo>
<TotalCount>10</TotalCount>
<LevelList>
<Description>Description of the table level</Description>
<LevelType>1</LevelType>
<ProjectId>123</ProjectId>
<LevelId>123</LevelId>
<Name>Level 1</Name>
</LevelList>
</TableLevelInfo>
<RequestId>abc</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<ErrorCode>1031203110005</ErrorCode>
<ErrorMessage>The specified parameters are invalid.</ErrorMessage>
<Success>true</Success>
JSON
format
{
"TableLevelInfo": {
"TotalCount": 10,
"LevelList": {
"Description": "Level description",
"LevelType": 1,
"ProjectId": 123,
"LevelId": 123,
"Name": "Level 1"
}
},
"RequestId": "abc",
"HttpStatusCode": 200,
"ErrorCode": 1031203110005,
"ErrorMessage": "The specified parameters are invalid.",
"Success": true
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
500 | InternalError.System | An internal system error occurred. Try again later. | The error message returned because an internal error has occurred. Try again later. |
500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | The error message returned because an internal error has occurred. Try again later. |
429 | Throttling.Api | The request for this resource has exceeded your available limit. | The error message returned because the number of requests for the resource has exceeded the upper limit. |
429 | Throttling.Api.Risk | The request for this resource has exceeded your daily available limit. | The error message returned because the number of requests per day for the resource has exceeded the upper limit. |
429 | Throttling.System | The DataWorks system is busy. Try again later. | The error message returned because the DataWorks system is busy. Try again later. |
429 | Throttling.User | Your request is too frequent. Try again later. | The error message returned because excessive requests have been submitted within a short period of time. Try again later. |
403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | The error message returned because you are not allowed to perform this operation. Activate DataWorks Enterprise Edition or DataWorks Ultimate Edition. |
For a list of error codes, visit the API Error Center.