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, and protocol.
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: 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. |
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. |
https://apigateway.tencentcloudapi.com/?Action=DescribeServiceForApiApp
&ServiceId=service-rypiqi13
&ApiRegion=ap-guangzhou
&<Common request parameters>
{
"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"
}
}
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 |
---|---|
InvalidParameter.FormatError | Incorrect parameter format. |
ResourceNotFound.InvalidService | The corresponding service is invisible. |
Was this page helpful?