1. 接口描述
接口请求域名: igtm.tencentcloudapi.com 。
修改策略接口
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyStrategy。 |
Version | 是 | String | 公共参数,本接口取值:2023-10-24。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
InstanceId | 是 | String | 实例id 示例值:gtm-Ul65AOsdfDvxVD |
StrategyId | 是 | Integer | 策略id 示例值:3 |
Source.N | 是 | Array of Source | 解析线路,需要全量传参 示例值:境外:欧洲,美国,东南亚 |
MainAddressPoolSet.N | 是 | Array of MainAddressPool | 主力地址池集合,需要全量传参 示例值:[{"AddressPools":[{"PoolId":1,"Weight":50}],"MinAliveNodeNum":1,"TrafficStrtegy":"weight"},{"AddressPools":[{"PoolId":3,"Weight":30}],"MinAliveNodeNum":1,"TrafficStrtegy":"weight"},{"AddressPools":[{"PoolId":3}],"MinAliveNodeNum":1,"TrafficStrtegy":"all"}] |
FallbackAddressPoolSet.N | 是 | Array of MainAddressPool | 兜底地址池集合,需要全量传参 示例值:[{"AddressPools":[{"PoolId":1}]}] |
StrategyName | 否 | String | 策略名称,不允许重复 示例值:name |
IsEnabled | 否 | String | 策略开启状态:ENABLED开启;DISABLED关闭 示例值:ENABLED |
KeepDomainRecords | 否 | String | 是否开启策略强制保留默认线路 disabled, enabled,默认不开启且只有一个策略能开启 示例值:enabled |
SwitchPoolType | 否 | String | 调度模式:AUTO默认;STOP仅暂停不切换 示例值:AUTO |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Msg | String | 是否成功 示例值:success |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改策略
输入示例
POST / HTTP/1.1
Host: igtm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyStrategy
<公共请求参数>
{
"InstanceId": "gtm-sdsdrdasd",
"StrategyId": 1,
"StrategyName": "test_strategy",
"Source": [
{
"DnsLineId": 1,
"Name": "默认"
}
],
"MainAddressPoolSet": [
{
"MainAddressPoolId": 1,
"AddressPools": [
{
"PoolId": 1,
"Weight": 1
}
],
"MinSurviveNum": 1,
"TrafficStrategy": "all"
}
],
"FallbackAddressPoolSet": [
{
"MainAddressPoolId": 1,
"AddressPools": [
{
"PoolId": 1,
"Weight": 1
}
],
"MinSurviveNum": 1,
"TrafficStrategy": "all"
}
],
"IsEnabled": "ENABLED",
"KeepDomainRecords": "DISABLED"
}
输出示例
{
"Response": {
"Msg": "success",
"RequestId": "abdsadasddc12312jhjyg"
}
}
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.CanNotDeleteDefaultLineError | 必须存在一条默认解析线路。 |
FailedOperation.ExceededLimit | 超出限额。 |
FailedOperation.ModifyError | 修改错误。 |
FailedOperation.ModifyStrategyFailed | 修改策略失败 |
FailedOperation.PoolWasUsingError | 地址池正在使用。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.InstanceDisabled | 实例不可用,请检查实例状态 |
InvalidParameter.TrafficStrategyInvalid | 流量策略不合法 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.TrafficStrategyWeightEmpty | 流量策略为负载均衡且主力集合内有多个地址池时,权重不能为空 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
ResourceInsufficient.NoInstance | 没有实例,请先购买实例 |
UnauthorizedOperation | 未授权操作。 |
UnauthorizedOperation.InstanceUnauthorized | 未授权,不可操作该实例 |
UnauthorizedOperation.MainBindPoolUnauthorized | 未授权,主力集合中包含未授权地址池 |
UnauthorizedOperation.MainPoolUnauthorized | 未授权,不可操作该主力地址池 |
UnauthorizedOperation.StrategyUnauthorized | 未授权,不可操作该策略 |
UnauthorizedOperation.UnauthorizedError | 资源未授权。 |
UnsupportedOperation | 操作不支持。 |
UnsupportedOperation.FallBackPoolInvalid | 兜底地址池格式不合法 |
UnsupportedOperation.MainBindPoolDuplicate | 主力地址池重复 |
UnsupportedOperation.MainBindPoolEmpty | 主力地址池为空 |
UnsupportedOperation.MainBindPoolLevelExceed | 主力地址集合数量超过限制 |
UnsupportedOperation.MainBindPoolMixed | 主力地址集合内地址类型不能混用 |
UnsupportedOperation.MainBindPoolNumInvalid | 主力地址集合数量不合法 |
UnsupportedOperation.MainPoolDuplicate | 主力地址集合重复 |
UnsupportedOperation.MainPoolEmpty | 主力集合不能为空 |
UnsupportedOperation.MainPoolSurviveNumInvalid | 主力地址池阀值不合法 |
UnsupportedOperation.ResourceNameDuplicated | 资源名不能重复。 |
UnsupportedOperation.ResourcePoolSourceNotExist | 主备资源组中资源不存在。 |
UnsupportedOperation.ResourceSourceDuplicated | 存在重复的解析来源。 |
UnsupportedOperation.StrategyNameDuplicate | 策略名称不能重复 |
UnsupportedOperation.StrategySourceDuplicate | 策略线路重复 |
UnsupportedOperation.StrategySourceInUsed | 策略线路已使用 |
UnsupportedOperation.StrategySourceUnauthorized | 策略线路不在实例套餐中 |
UnsupportedOperation.StrategySwitchTypeInvalid | 策略切换类型不合法 |
UnsupportedOperation.UserNotFound | 用户未登录,缺少Uin参数。 |