Inquire about the details of the service

Last updated: 2020-06-09 15:01:30


    This is a legacy API which has been hidden and will no longer be updated. We recommend using the new API Gateway API 3.0 which is standardized and faster.

    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

    &<Common request parameters>

    The returned results are as below:

        "code": "0",
        "message": "",
        "codeDesc": "Success",
        "serviceId": "service-XX",
        "serviceName": "test1",
        "serviceDesc": "test1",
        "subDomain": "",
        "protocol": "http",
        "createdTime": "2017-08-07T00:00:00Z",
        "modifiedTime": "2017-08-07T00:00:00Z",
        "availableEnvironments": [

    Was this page helpful?

    Was this page helpful?

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