1. 接口描述
接口请求域名: igtm.tencentcloudapi.com 。
策略详情
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeStrategyDetail。 |
Version | 是 | String | 公共参数,本接口取值:2023-10-24。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
InstanceId | 是 | String | 实例id 示例值:gtm-dsdd123xdo |
StrategyId | 是 | Integer | 策略 id 示例值:1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
StrategyDetail | StrategyDetail | 策略详情 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 策略详情
输入示例
POST / HTTP/1.1
Host: igtm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeStrategyDetail
<公共请求参数>
{
"InstanceId": "gtm-dsdd123xdo",
"StrategyId": 1
}
输出示例
{
"Response": {
"StrategyDetail": {
"InstanceId": "gtm-dsdd123xdo",
"StrategyId": 1,
"Name": "测试策略",
"Source": [
{
"DnsLineId": 1,
"Name": "默认"
}
],
"MainAddressPoolSet": [
{
"MainAddressPoolId": 1,
"AddressPools": [
{
"PoolId": 1,
"Weight": 1
}
],
"MinSurviveNum": 1,
"TrafficStrategy": "WEIGHT"
}
],
"FallbackAddressPoolSet": [
{
"MainAddressPoolId": 1,
"AddressPools": [
{
"PoolId": 1,
"Weight": 1
}
],
"MinSurviveNum": 1,
"TrafficStrategy": "WEIGHT"
}
],
"KeepDomainRecords": "DISABLED",
"CreatedOn": "2020-09-22T00:00:00+00:00",
"UpdatedOn": "2020-09-22T00:00:00+00:00"
},
"RequestId": "8f0325a8-4dd6-4fcb-8f6b-c45e587e51b0"
}
}
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 | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
ResourceNotFound.SearchInfo | 查询错误,未查询到相关资源。 |
UnauthorizedOperation | 未授权操作。 |
UnauthorizedOperation.StrategyUnauthorized | 未授权,不可操作该策略 |
UnauthorizedOperation.UnauthorizedError | 资源未授权。 |
UnsupportedOperation.UserNotFound | 用户未登录,缺少Uin参数。 |