1. 接口描述
接口请求域名: advisor.tencentcloudapi.com 。
查询评估项风险实例列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeTaskStrategyRisks。 |
Version | 是 | String | 公共参数,本接口取值:2020-07-21。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
StrategyId | 是 | Integer | 评估项ID 示例值:1 |
Limit | 否 | Integer | 返回数量,默认值为100,最大值为200 示例值:10 |
Offset | 否 | Integer | 偏移量,默认0 示例值:0 |
Env | 否 | String | 环境 示例值:"public" |
TaskType | 否 | String | 任务类型 示例值:"allTaskType" |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RiskFieldsDesc | Array of RiskFieldsDesc | 根据此配置,匹配风险实例列表(Risks)对应字段,例如: {"Response":{"RequestId":"111","RiskFieldsDesc":[{"Field":"InstanceId","FieldName":"ID","FieldType":"string","FieldDict":{}},{"Field":"InstanceName","FieldName":"名称","FieldType":"string","FieldDict":{}},{"Field":"InstanceState","FieldName":"状态","FieldType":"string","FieldDict":{"LAUNCH_FAILED":"创建失败","PENDING":"创建中","REBOOTING":"重启中","RUNNING":"运行中","SHUTDOWN":"停止待销毁","STARTING":"开机中","STOPPED":"关机","STOPPING":"关机中","TERMINATING":"销毁中"}},{"Field":"Zone","FieldName":"可用区","FieldType":"string","FieldDict":{}},{"Field":"PrivateIPAddresses","FieldName":"IP地址(内)","FieldType":"stringSlice","FieldDict":{}},{"Field":"PublicIPAddresses","FieldName":"IP地址(公)","FieldType":"stringSlice","FieldDict":{}},{"Field":"Region","FieldName":"地域","FieldType":"string","FieldDict":{}},{"Field":"Tags","FieldName":"标签","FieldType":"tags","FieldDict":{}}],"RiskTotalCount":3,"Risks":"[{"InstanceId":"ins-xxx1","InstanceName":"xxx1","InstanceState":"RUNNING","PrivateIPAddresses":["1.17.64.2"],"PublicIPAddresses":null,"Region":"ap-shanghai","Tags":null,"Zone":"ap-shanghai-2"},{"InstanceId":"ins-xxx2","InstanceName":"xxx2","InstanceState":"RUNNING","PrivateIPAddresses":["1.17.64.11"],"PublicIPAddresses":null,"Region":"ap-shanghai","Tags":null,"Zone":"ap-shanghai-2"}]","StrategyId":9}} 注意:此字段可能返回 null,表示取不到有效值。 |
StrategyId | Integer | 评估项ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
RiskTotalCount | Integer | 风险实例个数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
Risks | String | 风险实例详情列表,需要json decode 注意:此字段可能返回 null,表示取不到有效值。 |
ResourceCount | Integer | 巡检资源数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询评估项风险实例列表
输入示例
POST / HTTP/1.1
Host: advisor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTaskStrategyRisks
<公共请求参数>
{
"StrategyId": 9
}
输出示例
{
"Response": {
"RequestId": "111",
"RiskFieldsDesc": [
{
"Field": "InstanceId",
"FieldName": "ID",
"FieldType": "string",
"FieldDict": {}
},
{
"Field": "InstanceName",
"FieldName": "名称",
"FieldType": "string",
"FieldDict": {}
},
{
"Field": "InstanceState",
"FieldName": "状态",
"FieldType": "string",
"FieldDict": {}
},
{
"Field": "Zone",
"FieldName": "可用区",
"FieldType": "string",
"FieldDict": {}
},
{
"Field": "PrivateIPAddresses",
"FieldName": "IP地址(内)",
"FieldType": "stringSlice",
"FieldDict": {}
},
{
"Field": "PublicIPAddresses",
"FieldName": "IP地址(公)",
"FieldType": "stringSlice",
"FieldDict": {}
},
{
"Field": "Region",
"FieldName": "地域",
"FieldType": "string",
"FieldDict": {}
},
{
"Field": "Tags",
"FieldName": "标签",
"FieldType": "tags",
"FieldDict": {}
}
],
"RiskTotalCount": 3,
"ResourceCount": 10,
"Risks": "[{\"InstanceId\":\"ins-xxx1\",\"InstanceName\":\"xxx1\",\"InstanceState\":\"RUNNING\",\"PrivateIPAddresses\":[\"1.17.64.2\"],\"PublicIPAddresses\":null,\"Region\":\"ap-shanghai\",\"Tags\":null,\"Zone\":\"ap-shanghai-2\"},{\"InstanceId\":\"ins-xxx2\",\"InstanceName\":\"xxx2\",\"InstanceState\":\"RUNNING\",\"PrivateIPAddresses\":[\"1.17.64.11\"],\"PublicIPAddresses\":null,\"Region\":\"ap-shanghai\",\"Tags\":null,\"Zone\":\"ap-shanghai-2\"}]",
"StrategyId": 9
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InternalError.DependsDb | 依赖的db出错。 |
InternalError.System | 系统错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.ParamError | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
ResourceNotFound | 资源不存在。 |