DescribeService

Last updated: 2020-07-17 09:42:08

1. API Description

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

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

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: apigateway.ap-shanghai-fsi.tencentcloudapi.com

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: DescribeService.
Version Yes String Common parameter. The value used for this API: 2018-08-08.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
ServiceId Yes String Unique ID of the service to be queried.

3. Output Parameters

Parameter Name Type Description
ServiceId String Unique service ID.
AvailableEnvironments Array of String Service environment list.
ServiceName String Service name.
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 Service creation time.
ModifiedTime Timestamp Service modification time.
ExclusiveSetName String Self-deployed cluster name.
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.
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.
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.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying service details

Input Example

https://apigateway.tencentcloudapi.com/?Action=DescribeService
&ServiceId=service-rypiqi13
&<Common request parameters>

Output Example

{
  "Response": {
    "ServiceId": "service-rypiqi13",
    "AvailableEnvironments": [
      "release"
    ],
    "ServiceName": "dd",
    "ServiceDesc": "",
    "Protocol": "http",
    "CreatedTime": "2020-04-15T11:03:41Z",
    "ModifiedTime": "2020-04-15T11:03:42Z",
    "ExclusiveSetName": "",
    "IpVersion": "IPv4",
    "UserType": "",
    "NetTypes": [
      "OUTER"
    ],
    "InternalSubDomain": "",
    "OuterSubDomain": "service-rypiqi13-1259027407.bj.apigw.tencentcs.com",
    "InnerHttpPort": 0,
    "InnerHttpsPort": 0,
    "SetId": 1,
    "ApiTotalCount": 1,
    "ApiIdStatusSet": [
      {
        "ServiceId": "service-rypiqi13",
        "ApiId": "api-mpnvjg0b",
        "ApiDesc": "",
        "Path": "/",
        "Method": "GET",
        "CreatedTime": "2020-05-18T11:11:04Z",
        "ModifiedTime": "2020-05-18T11:11:04Z",
        "ApiName": "test_tag",
        "UniqVpcId": "",
        "ApiType": "NORMAL",
        "Protocol": "HTTP",
        "IsDebugAfterCharge": false,
        "AuthType": "NONE",
        "ApiBusinessType": "NORMAL",
        "AuthRelationApiId": "",
        "OauthConfig": null,
        "TokenLocation": null,
        "RelationBuniessApiIds": null
      }
    ],
    "UsagePlanTotalCount": 0,
    "UsagePlanList": [],
    "RequestId": "b15e7661-c598-4747-85f9-44fc44118608"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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
ResourceNotFound.InvalidService The corresponding service is invisible.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help