The query service has been the version of publish

Last updated: 2020-06-09 14:58:04

    Note:

    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 (DescribeServiceReleaseVersion) queries the list of all publish versions under a service.
    Users often have multiple versions of publish when serving publish. You can use this API to query the version of publish.

    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
    Limit No Int The returned quantity
    Offset No Int Offset

    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
    TotalCount String Total number of publish versions
    VersionList List of Array Version list

    VersionList is a list of historical versions. It is an array of versionAttribute. The versionAttribute is composed as follows:

    Parameter name Type Description
    VersionName String Version ID
    VersionDesc String Version description
    Environments List of String The current environment list of publish in this version
    CreateTime Time Version creation time

    Example

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

    The returned results are as below:

    {
        "code": "0",
        "message": "",
        "codeDesc": "Success",
        "totalCount": 2,
        "versionList": [{
                "versionName": "version-20170904xx",
                "versionDesc": "desc",
                "environments": [
                    "test",
                    "prepub"
                ],
                "createTime": "2017-09-27 00:00::00"
            },
            {
                "versionName": "version-20170905xx",
                "versionDesc": "desc",
                "environments": [
                    "release"
                ],
                "createTime": "2017-09-27 00:00::00"
            }
        ]
    }

    Was this page helpful?

    Was this page helpful?

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