1. 接口描述
接口请求域名: apigateway.tencentcloudapi.com 。
本接口(UnReleaseService)用于下线服务。
用户发布服务到某个环境后,此服务中的 API 方可被调用者进行调用,当用户需要将此服务从发布环境中下线时,可调用此 API。下线后的服务不可被调用。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:UnReleaseService。 |
Version | 是 | String | 公共参数,本接口取值:2018-08-08。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ServiceId | 是 | String | 待下线服务的唯一 ID。 示例值:service-ody35h5e |
EnvironmentName | 是 | String | 待下线的环境名称,当前支持三个环境,test(测试环境)、prepub(预发布环境)和 release(发布环境)。 示例值:prepub |
ApiIds.N | 否 | Array of String | 保留字段,待下线的API列表。 示例值:api-hnetytr6 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Result | Boolean | 下线操作是否成功。 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 UnReleaseService
输入示例
https://apigateway.tencentcloudapi.com/?Action=UnReleaseService
&ServiceId=service-ody35h5e
&EnvironmentName=prepub
&<公共请求参数>
输出示例
{
"Response": {
"Result": true,
"RequestId": "42aafae4-3023-4211-a10a-109163118bb0"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.ServiceError | 服务相关的错误。 |
FailedOperation.ServiceInOperation | 当前Service正在操作中, 请稍后再试。 |
InternalError.OssException | oss内部请求错误,请稍后重试。若无法解决,请联系智能客服或提交工单。 |
InvalidParameter.FormatError | 参数格式错误。 |
InvalidParameterValue.InvalidRegion | 地域错误。 |
LimitExceeded.RequestLimitExceeded | 请求频率超限制,请稍等再试。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.InvalidService | 对应服务不可见。 |
UnauthorizedOperation | 未授权操作。 |
UnsupportedOperation.UnpackError | Unpack函数错误 |