Help & DocumentationAPIsAPI GatewayService APIsInquire about the details of the service

Inquire about the details of the service

Last updated: 2020-02-21 16:26:35

Interface description

This API (DescribeService) is used to query the details of a service, including service description, domain name, Protocol, creation time, publish and other information.

Input Parameter

The following request parameter list only lists the API request parameters. For other parameters, please see Common Request Parameters .

Parameter name Required Type Description
ServiceId Yes String Unique ID for the service to be queried

Output Parameter

Parameter name Type Description
Code Int Common error code, 0 indicates success, other values indicate failure. For more information, please see the error code page Common error code
CodeDesc String Error code on the business side. Return the specific cause of the business error when a Success, error is returned on success.
Message String Module error message description, related to interface
ServiceId String Service unique ID
ServiceName String User-defined service name
ServiceDesc String Service description
SubDomain String The system automatically gives the service the domain name of Assign.
Protocol String The front-end request type of the service. Such as HTTP and HTTPS
CreatedTime Timestamp Policy creation time. Expressed according to the ISO8601 standard, and using UTC time. Format: YYYY-MM-DDThh:mm:ssZ
ModifiedTime Timestamp Last Modification Time. Expressed according to the ISO8601 standard, and using UTC time. Format: YYYY-MM-DDThh:mm:ssZ
AvailableEnvironments List Of String List of environments that have been publish, such as Test, Pre, release

Example

https://apigateway.api.qcloud.com/v2/index.php?
&<Common request parameters>
&Action=DescribeService
&serviceId=service-XX

The returned results are as below:

{
    "code": "0",
    "message": "",
    "codeDesc": "Success",
    "serviceId": "service-XX",
    "serviceName": "test1",
    "serviceDesc": "test1",
    "subDomain": "523e8dc7bbe04613b5b1d726c2a7889d-apigateway.ap-guangzhou.qcloud.com",
    "protocol": "http",
    "createdTime": "2017-08-07T00:00:00Z",
    "modifiedTime": "2017-08-07T00:00:00Z",
    "availableEnvironments": [
        "Pre",
        "release"
    ]
}