1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
修改自动扩容配置(多模块可扩展,本期仅主机安全模块)。
「自动扩容」为面向用户的对外概念,等价于底层自动加购(auto_repurchase):当账号有新增资产时,自动加购所需授权。
补充说明:
- 本期仅实现主机安全模块 HostConfig;后续可扩展容器安全、AI-Agent 安全等命名模块字段,各模块配置字段可异构;
- 部分更新语义:模块对象为空表示该模块不修改,模块内字段为空表示该字段不修改;
- HostConfig.Switch 联动映射 auto_repurchase_switch;auto_bind_switch(自动绑定)恒开,不由本接口改动;
- 自动续费(renew_flag) 不由本接口改动;额度/用量请调用 DescribeLicenseStatus;
- 顶部「自动扩容」总开关状态由前端按各模块开关聚合,后端不存储、不返回全局开关。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ModifyPayConfig。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| HostConfig | 否 | HostAutoScaleConfig | 主机安全模块自动扩容配置 补充说明:不传则不修改主机配置;本期至少需传本模块。后续可扩展 ContainerConfig / AIAgentConfig 命名模块字段 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 开启主机自动扩容并选择旗舰版
计费配置弹窗开启主机自动扩容并选择旗舰版
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyPayConfig
<公共请求参数>
{
"HostConfig": {
"Switch": "ON",
"ProtectType": "ULTIMATE"
}
}
输出示例
{
"Response": {
"RequestId": "5cd96106-1d72-466c-9bcf-9876543210ab"
}
}
示例2 关闭主机自动扩容
计费配置弹窗关闭主机自动扩容
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyPayConfig
<公共请求参数>
{
"HostConfig": {
"Switch": "OFF"
}
}
输出示例
{
"Response": {
"RequestId": "d479fbf3-9840-4dd3-c5f9-9f5395ba4c52"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。