下线服务

最近更新时间:2019-04-26 15:16:09

接口描述

本接口(UnReleaseService)用于下线服务。
用户发布服务到某个环境后,此服务中的 API 方可被调用者进行调用,当用户需要将此服务从发布环境中下线时,可调用此 API。下线后的服务不可被调用。

输入参数

以下请求参数列表仅列出了接口请求参数,其它参数可参考 公共请求参数

参数名称 是否必选 类型 描述
serviceId String 待下线服务的唯一 ID。
environmentName Boolean 待下线的环境名称,当前支持三个环境,测试:test,预发:prepub,线上:release
unReleaseDesc String 本次的下线描述。

输出参数

参数名称 类型 描述
code Int 公共错误码, 0 表示成功,其他值表示失败。详见错误码页面的 公共错误码
codeDesc String 业务侧错误码。成功时返回 Success,错误时返回具体业务错误原因。
message String 模块错误信息描述,与接口相关。

示例

https://apigateway.api.qcloud.com/v2/index.php?
&<公共请求参数>
&Action=UnReleaseService
&serviceId=service=XX
&environmentName=Online
&unReleaseDesc=下线描述

返回示例如下:

{
    "code":"0",
    "message":"",
    "codeDesc":"Success",    
    "unReleaseDesc":"unReleaseDesc"
}