tencent cloud

All product documents
APIs
DocumentationAPIsAPI GatewayApplication APIsDescribeServiceForApiApp
DescribeServiceForApiApp
Last updated: 2025-01-13 11:24:33
DescribeServiceForApiApp
Last updated: 2025-01-13 11:24:33

1. API Description

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

This API is used to query the details of a service, such as its description, domain name, and protocol.

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: DescribeServiceForApiApp.
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 ID of the service to be queried.
ApiRegion Yes String Service region.

3. Output Parameters

Parameter Name Type Description
ServiceId String Unique service ID.
AvailableEnvironments Array of String Service environment list.
Note: this field may return null, indicating that no valid values can be obtained.
ServiceName String Service name.
Note: this field may return null, indicating that no valid values can be obtained.
ServiceDesc String Service description.
Note: this field may return null, indicating that no valid values can be obtained.
Protocol String Protocol supported by service. Valid values: http, https, http&https.
CreatedTime Timestamp ISO8601 Service creation time.
Note: this field may return null, indicating that no valid values can be obtained.
ModifiedTime Timestamp ISO8601 Service modification time.
Note: this field may return null, indicating that no valid values can be obtained.
NetTypes Array of String Network type list. INNER: private network access; OUTER: public network access.
InternalSubDomain String Subdomain name for private network access.
OuterSubDomain String Subdomain name for public network access.
InnerHttpPort Integer Service port number for HTTP access over private network.
InnerHttpsPort Integer Port number for HTTPS access over private network.
ApiTotalCount Integer Total number of APIs.
Note: this field may return null, indicating that no valid values can be obtained.
ApiIdStatusSet Array of ApiIdStatus API list.
Note: this field may return null, indicating that no valid values can be obtained.
UsagePlanTotalCount Integer Total number of usage plans.
Note: this field may return null, indicating that no valid values can be obtained.
UsagePlanList Array of UsagePlan Usage plan array.
Note: this field may return null, indicating that no valid values can be obtained.
IpVersion String IP version.
Note: this field may return null, indicating that no valid values can be obtained.
UserType String Service user type.
Note: this field may return null, indicating that no valid values can be obtained.
SetId Integer Reserved field.
Note: this field may return null, indicating that no valid values can be obtained.
Tags Array of Tag Tag bound to the service.
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 DescribeServiceForApiApp

Input Example

https://apigateway.intl.tencentcloudapi.com/?Action=DescribeServiceForApiApp
&ServiceId=service-rypiqi13
&ApiRegion=ap-guangzhou
&<Common request parameters>

Output Example

{
    "Response": {
        "ServiceDesc": "xx",
        "CreatedTime": "2020-09-22T00:00:00+00:00",
        "SetId": 1,
        "InnerHttpsPort": 0,
        "InnerHttpPort": 0,
        "Tags": [
            {
                "Value": "xx",
                "Key": "xx"
            }
        ],
        "NetTypes": [
            "OUTER"
        ],
        "IpVersion": "xx",
        "UserType": "xx",
        "UsagePlanList": [
            {
                "MaxRequestNumPreSec": 0,
                "UsagePlanId": "xx",
                "ModifiedTime": "2020-09-22T00:00:00+00:00",
                "UsagePlanDesc": "xx",
                "Environment": "xx",
                "CreatedTime": "2020-09-22T00:00:00+00:00",
                "UsagePlanName": "xx"
            }
        ],
        "OuterSubDomain": "xx",
        "UsagePlanTotalCount": 0,
        "ApiIdStatusSet": [
            {
                "AuthType": "xx",
                "Protocol": "xx",
                "UniqVpcId": "xx",
                "ModifiedTime": "2020-09-22T00:00:00+00:00",
                "OauthConfig": {
                    "PublicKey": "xx",
                    "LoginRedirectUrl": "xx",
                    "TokenLocation": "xx"
                },
                "ApiId": "xx",
                "AuthRelationApiId": "xx",
                "ApiDesc": "xx",
                "ApiType": "xx",
                "ApiBusinessType": "xx",
                "ServiceId": "xx",
                "ApiName": "xx",
                "Path": "xx",
                "CreatedTime": "2020-09-22T00:00:00+00:00",
                "RelationBuniessApiIds": [
                    "xx"
                ],
                "IsDebugAfterCharge": false,
                "Method": "xx",
                "TokenLocation": "xx"
            }
        ],
        "ServiceName": "xx",
        "RequestId": "xx",
        "Protocol": "xx",
        "ApiTotalCount": 1,
        "ModifiedTime": "2020-09-22T00:00:00+00:00",
        "AvailableEnvironments": [
            "release"
        ],
        "ServiceId": "xx",
        "InternalSubDomain": "xx"
    }
}

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
InvalidParameter.FormatError Incorrect parameter format.
ResourceNotFound.InvalidService The corresponding service is invisible.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

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

Contact Us
Technical Support

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

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon