DescribeService

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2021-05-19 14:47:03

Download PDF

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 ISO8601	Service creation time.
ModifiedTime	Timestamp ISO8601	Service modification time.
ExclusiveSetName	String	Dedicated 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.
Tags	Array of Tag	Tags bound to a service. Note: this field may return null, indicating that no valid values found.
InstanceId	String	Dedicated instance ID Note: this field may return null, indicating that no valid values can be obtained.
InstanceName	String	Dedicated instance name Note: this field may return null, indicating that no valid values can be obtained.
SetType	String	Cluster type 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": {
    "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,
    "SetType": "xx",
    "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",
    "InstanceName": "xx",
    "Protocol": "xx",
    "ApiTotalCount": 1,
    "ModifiedTime": "2020-09-22T00:00:00+00:00",
    "ExclusiveSetName": "xx",
    "InstanceId": "xx",
    "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

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
AuthFailure	Error with CAM signature/authentication.
DryRunOperation	`DryRun` Operation. It means that the request would have succeeded, but the `DryRun` parameter was used.
FailedOperation	Operation failed.
InternalError	Internal error.
InvalidParameter.FormatError	Incorrect parameter format.
InvalidParameterValue.InvalidRegion	Incorrect region.
ResourceNotFound.InvalidService	The corresponding service is invisible.
UnauthorizedOperation.AccessResource	You do not have permission to access the resource.

Recent Pages