1. 接口描述
接口请求域名: tdcpg.tencentcloudapi.com 。
开启或者关闭接入点外网
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyClusterEndpointWanStatus。 |
Version | 是 | String | 公共参数,本接口取值:2021-11-18。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ClusterId | 是 | String | 集群ID 示例值:tdcpg-xxx |
EndpointId | 是 | String | 接入点ID 示例值:tdcpg-ep-xxx |
WanStatus | 是 | String | 取值为: - OPEN:开启外网 - CLOSE:关闭外网 示例值:OPEN |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改接入点外网状态
输入示例
POST / HTTP/1.1
Host: tdcpg.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyClusterEndpointWanStatus
<公共请求参数>
{
"ClusterId": "tdcpg-xxx",
"EndpointId": "tdcpg-ep-xxx",
"WanStatus": "OPEN"
}
输出示例
{
"Response": {
"RequestId": "03ea3f94-297d-11eb-8f30-525400b7dd5a"
}
}
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 | 操作失败。 |
FailedOperation.DatabaseAccessError | 元数据库访问失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
FailedOperation.FlowError | 创建流程失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
FailedOperation.StatusError | 状态异常,不允许操作。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.ClusterNotFound | 集群不存在。 |
InvalidParameterValue.EndpointNotFound | 接入点不存在。 |
InvalidParameterValue.InvalidParameterValueError | 传入的参数非法。 |
UnauthorizedOperation | 未授权操作。 |
UnauthorizedOperation.PermissionDenied | 未经授权的操作。 |