DescribeApplications

Last updated: 2021-06-04 17:31:38

1. API Description

Domain name for API request: tcaplusdb.tencentcloudapi.com.

This API is used to query the list of cluster operation applications.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeApplications.
Version Yes String Common parameter. The value used for this API: 2019-08-23.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
ClusterId No String ID of the cluster whose applications will be queried
Limit No Integer The maximum number of results returned per page
Offset No Integer Pagination offset
CensorStatus No Integer Application status used as a filter condition
TableGroupId No String Table group ID used as a filter condition
TableName No String Table name used as a filter condition
Applicant No String Applicant UIN used as a filter condition
ApplyType No Integer Application type used as a filter condition

3. Output Parameters

Parameter Name Type Description
Applications Array of Application Application list
TotalCount Integer Total number of applications
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the list of cluster operation applications

Input Example

POST / HTTP/1.1
Host: tcaplusdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApplications
<Common request parameters>

{
    "TableGroupId": "xx",
    "ClusterId": "xx",
    "Applicant": "xx",
    "TableName": "xx",
    "Limit": 1,
    "Offset": 1,
    "CensorStatus": 0,
    "ApplyType": 0
}

Output Example

{
  "Response": {
    "Applications": [
      {
        "Applicant": "100000012683",
        "ApplicationId": "4-169",
        "ApplicationStatus": 2,
        "ApplicationType": 2,
        "CanCensor": true,
        "CanWithdrawal": false,
        "ClusterId": "4",
        "ClusterName": "xml_1_ly",
        "CreatedTime": "2021-02-25 11:58:37",
        "ExecuteStatus": "-1",
        "ExecuteUser": "222",
        "TableGroupId": "1",
        "TableGroupName": "zone_1_1",
        "TableInstanceId": "null",
        "TableName": "add_table10",
        "TaskId": "0",
        "UpdateTime": "2021-02-25 11:58:37"
      }
    ],
    "RequestId": "fdsfdsfdsfdsf",
    "TotalCount": 92
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure.UnauthorizedOperation API operation authentication error.
FailedOperation.RegionMismatch The requested region does not match.
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue Incorrect parameter value.
ResourceNotFound The resource does not exist.