1. 接口描述
接口请求域名: gaap.tencentcloudapi.com 。
本接口(ModifyProxyConfiguration)用于修改通道的配置。根据当前业务的容量需求,扩容或缩容相关通道的配置。仅支持Scalarable为1的通道,Scalarable可通过接口DescribeProxies获取。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyProxyConfiguration。 |
Version | 是 | String | 公共参数,本接口取值:2018-05-29。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
InstanceId | 否 | String | (旧参数,请切换到ProxyId)通道的实例ID。 示例值:[] |
Bandwidth | 否 | Integer | 需要调整到的目标带宽,单位:Mbps。 Bandwidth与Concurrent必须至少设置一个。取值范围根据DescribeAccessRegionsByDestRegion接口获取得到 示例值:10 |
Concurrent | 否 | Integer | 需要调整到的目标并发值,单位:万。 Bandwidth与Concurrent必须至少设置一个。取值范围根据DescribeAccessRegionsByDestRegion接口获取得到 示例值:2 |
ClientToken | 否 | String | 用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。 更多详细信息请参阅:如何保证幂等性。 |
ProxyId | 否 | String | (新参数)通道的实例ID。 示例值:link-4ftf12sb |
BillingType | 否 | Integer | 计费方式 (0:按带宽计费,1:按流量计费 默认按带宽计费) 示例值:0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改通道配置
输入示例
POST / HTTP/1.1
Host: gaap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyProxyConfiguration
<公共请求参数>
{
"ProxyId": "link-4ftf12sb",
"Concurrent": "2",
"Bandwidth": "10"
}
输出示例
{
"Response": {
"RequestId": "967ef39b-b096-4338-a1c9-4b42977dde0e"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
AuthFailure.NotEnterpriseAuthorization | 非企业认证客户。 |
AuthFailure.UnauthorizedOperation | 子账户未授权操作。 |
FailedOperation | 操作失败。 |
FailedOperation.AccountBalanceInsufficient | 账户余额不足,无法创建该通道。 |
FailedOperation.DuplicatedRequest | 重复的请求,请检查ClientToken的值。 |
FailedOperation.Migration | 加速通道在升级中,暂不支持配置变更,请提工单申请。 |
FailedOperation.NonStandardProxy | 该通道为非标通道,限制所有写操作。 |
FailedOperation.NotSupportScalar | 不支持配置变更。 |
FailedOperation.RealServerAlreadyBound | 已经绑定了源站,无法删除。 |
FailedOperation.UserNotConfirmProtocol | 未开通协议。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourceUnavailable.AccountViolation | 账号下存在违规资源,详情请查看站内信或邮件。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |