DescribeSubAppIds

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2021-06-15 19:03:49

Download PDF

1. API Description

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

This API is used to query the list of the primary application and subapplications of the current account.

A maximum of 100 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: DescribeSubAppIds.
Version	Yes	String	Common parameter. The value used for this API: 2018-07-17.
Region	No	String	Common parameter. This parameter is not required for this API.
Name	No	String	Subapplication name.
Tags.N	No	Array of ResourceTag	Tag information. You can query the list of subapplications with specified tags.
Offset	No	Integer	Page number offset from the beginning of paginated queries. Default value: 0.
Limit	No	Integer	Maximum return results of pulling paginated queries. Default: 200; maximum: 200.

3. Output Parameters

Parameter Name	Type	Description
SubAppIdInfoSet	Array of SubAppIdInfo	Subapplication information set.
TotalCount	Integer	Total number of subapplications.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying subapplication resource list

Input Example

https://vod.tencentcloudapi.com/?Action=DescribeSubAppIds
&<Common request parameters>

Output Example

{
  "Response": {
    "SubAppIdInfoSet": [
      {
        "SubAppId": 1451123904,
        "Name": "Subapplication 1",
        "Description": "Overview of subapplication 1",
        "CreateTime": "2018-10-01T10:00:00Z",
        "Status": "On"
      },
      {
        "SubAppId": 1251123904,
        "Name": "Primary application",
        "Description": "",
        "CreateTime": "2018-10-01T10:00:00Z",
        "Status": "On"
      }
    ],
    "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
  }
}

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

Tencent Cloud CLI 3.0

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
FailedOperation	Operation failed.
InternalError	Internal error.
ResourceNotFound	The resource does not exist.
UnauthorizedOperation	Unauthorized operation.

Recent Pages