tencent cloud



Last updated: 2022-05-05 16:20:46

1. API Description

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

This API is used to view a certain API or the list of all APIs under a service and relevant information.

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 Params. The value used for this API: DescribeApisStatus.
Version Yes String Common Params. The value used for this API: 2018-08-08.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ServiceId Yes String Unique service ID of API.
Offset No Integer Offset. Default value: 0.
Limit No Integer Number of returned results. Default value: 20. Maximum value: 100.
Filters.N No Array of Filter API filter. Valid values: ApiId, ApiName, ApiPath, ApiType, AuthRelationApiId, AuthType, ApiBuniessType, NotUsagePlanId, Environment, Tags (whose values are the list of $tag_key:tag_value), TagKeys (whose values are the list of tag keys).

3. Output Parameters

Parameter Name Type Description
Result ApisStatus List of API details.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying API status

Input Example

&<Common request parameters>

Output Example

  "Response": {
    "Result": {
      "TotalCount": 1,
      "ApiIdStatusSet": [
          "RelationBuniessApiIds": [
          "CreatedTime": "2020-09-22T00:00:00+00:00",
          "Method": "xx",
          "VpcId": 0,
          "Tags": [
          "IsDebugAfterCharge": false,
          "ApiBusinessType": "xx",
          "ApiName": "xx",
          "Path": "xx",
          "AuthType": "xx",
          "ApiDesc": "xx",
          "OauthConfig": {
            "PublicKey": "xx",
            "LoginRedirectUrl": "xx",
            "TokenLocation": "xx"
          "AuthRelationApiId": "xx",
          "Protocol": "xx",
          "ModifiedTime": "2020-09-22T00:00:00+00:00",
          "UniqVpcId": "xx",
          "ApiId": "xx",
          "ApiType": "xx",
          "ServiceId": "xx"
    "RequestId": "xx"

5. Developer Resources


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
FailedOperation.ServiceNotExist The service does not exist.
InvalidParameter.FormatError Incorrect parameter format.
InvalidParameterValue.InvalidFilterNotSupportedName The parameter value is incorrect.
InvalidParameterValue.InvalidRegion Incorrect region.
ResourceNotFound.InvalidService The corresponding service is invisible.
UnsupportedOperation.InvalidAction API error.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support