ListTableTheme - DataWorks - Alibaba Cloud Documentation Center

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	ListTableTheme	The operation that you want to perform.
ProjectId	Long	Yes	123	The ID of the DataWorks workspace.
RegionId	String	Yes	cn-shanghai	The ID of the region where the service is activated.
ParentId	Long	No	121	The ID of the parent table folder.
PageNum	Integer	No	1	The number of the page to return.
PageSize	Integer	No	10	The number of entries to return on each page. Default value:10. Maximum value: 100.

Response parameters


Parameter	Type	Example	Description
Data	Struct		The returned data about the level of the table folder.
ThemeList	Array of ThemeList		The list of levels of the table folders.
CreateTimeStamp	Long	123432343243	The time when the level was created.
Creator	String	123455	The creator of the level.
Level	Integer	1	The level of the table folder. Valid values: 1 and 2. A value of 1 indicates a table folder of level 1. A value of 2 indicates a table folder of level 2.
Name	String	Name of the level of the table folder	The name of the level of the table folder.
ParentId	Long	122	The ID of the parent node.
ProjectId	Long	123	The ID of the DataWorks workspace.
ThemeId	Long	123	The ID of the table folder.
TotalCount	Long	10	The total number of table folders.
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	abcde	The ID of the request.
Success	Boolean	true	Indicates whether the request is successful.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListTableTheme
&ProjectId=123
&RegionId=cn-shanghai
&<Common request parameters>

Sample success responses

XML format

<RequestId>abcde</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <ThemeList>
        <ParentId>122</ParentId>
        <ThemeId>123</ThemeId>
        <ProjectId>123</ProjectId>
        <Level>1</Level>
        <Creator>123455</Creator>
        <CreateTimeStamp>123432343243</CreateTimeStamp>
        <Name>Name of the level of the table folder</Name>
    </ThemeList>
    <TotalCount>10</TotalCount>
</Data>
<ErrorCode>1031203110005</ErrorCode>
<ErrorMessage>The specified parameters are invalid.</ErrorMessage>
<Success>true</Success>

JSON format

{
    "RequestId": "abcde",
    "HttpStatusCode": 200,
    "Data": {
        "ThemeList": {
            "ParentId": 122,
            "ThemeId": 123,
            "ProjectId": 123,
            "Level": 1,
            "Creator": 123455,
            "CreateTimeStamp": 123432343243,
            "Name": "Name of the level of the table folder"
        },
        "TotalCount": 10
    },
    "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.