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.
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: DescribeService. |
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. |
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. |
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. |
DeploymentType | String | Cluster type for service deployment Note: this field may return null, indicating that no valid values found. |
SpecialUse | String | Whether the service if for special usage. Valid values: DEFAULT (general usage), HTTP_DNS .Note: This field may return NULL , indicating that no valid value was found. |
UniqVpcId | String | |
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. |
POST / HTTP/1.1
Host: apigateway.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeService
<Common Request Parameters>
{
"ServiceId": "service-rypiqi13"
}
{
"Response": {
"ServiceDesc": "sesrxx",
"CreatedTime": "2020-09-22T00:00:00+00:00",
"SetId": 1,
"InnerHttpsPort": 0,
"InnerHttpPort": 0,
"Tags": [
{
"Value": "test",
"Key": "test"
}
],
"NetTypes": [
"OUTER"
],
"IpVersion": "",
"UserType": "",
"UsagePlanList": [
{
"MaxRequestNumPreSec": 0,
"UsagePlanId": "",
"ModifiedTime": "2020-09-22T00:00:00+00:00",
"UsagePlanDesc": "test",
"Environment": "test",
"CreatedTime": "2020-09-22T00:00:00+00:00",
"UsagePlanName": "sdfafxx"
}
],
"OuterSubDomain": "domain.com",
"UsagePlanTotalCount": 0,
"SetType": "",
"ApiIdStatusSet": [
{
"AuthType": "",
"Protocol": "",
"UniqVpcId": "",
"ModifiedTime": "2020-09-22T00:00:00+00:00",
"OauthConfig": {
"PublicKey": "",
"LoginRedirectUrl": "",
"TokenLocation": ""
},
"ApiId": "",
"AuthRelationApiId": "",
"ApiDesc": "",
"ApiType": "",
"ApiBusinessType": "",
"ServiceId": "",
"ApiName": "",
"Path": "",
"CreatedTime": "2020-09-22T00:00:00+00:00",
"RelationBuniessApiIds": [
""
],
"IsDebugAfterCharge": false,
"Method": "",
"TokenLocation": ""
}
],
"ServiceName": "",
"RequestId": "",
"InstanceName": "",
"Protocol": "",
"ApiTotalCount": 1,
"ModifiedTime": "2020-09-22T00:00:00+00:00",
"DeploymentType": "DEFAULT",
"SpecialUse": "DEFAULT",
"InstanceId": "",
"AvailableEnvironments": [
"release"
],
"ServiceId": "",
"InternalSubDomain": ""
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
FailedOperation.CamException | |
FailedOperation.ServiceInOperation | The service is in use. Please try again later. |
InternalError | Internal error. |
InternalError.CamException | |
InternalError.OssException | OSS internal request error. Please try again. If the problem persists, please contact the smart customer service or submit a ticket. |
InternalError.ReturnableException | |
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. |
UnsupportedOperation.RequestPostError | |
UnsupportedOperation.UnpackError |
Was this page helpful?