1. 接口描述
接口请求域名： cloudadvisor.api3.gds-cloud.com。
查询评估项风险实例列表
默认接口请求频率限制：20次/秒。
接口更新时间：2021-12-02 21:32:48。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeTaskStrategyRisks |
| Version | 是 | 否 | String | 公共参数，本接口取值：2020-07-21 |
| Region | 是 | 否 | String | 公共参数，地域信息本接口不需要传递此参数。 |
| StrategyId | 是 | 否 | Uint64 | 评估项ID 示例值： 1 |
| Limit | 否 | 否 | Uint64 | 限制数量,默认100 示例值： 10 |
| Offset | 否 | 否 | Uint64 | 偏移量,默认0 示例值： 0 |
| TaskID | 否 | 否 | String | 任务ID 示例值： e9ea4f2a-98c5-47ed-9706-a7446a06ad1a |
| Filters | 否 | 否 | Array of Filters | 过滤条件，支持: 1. level 等级，2：中风险，3：高风险 2. fuzzy 模糊搜索，用作ID或名称过滤 示例值：查看 |
| IncludeAllFields | 否 | 否 | Bool | 是否包含所有字段 示例值： false |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RiskFieldsDesc | 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}} 示例值：查看 |
| StrategyId | Uint64 | 评估项ID 示例值： 1 |
| RiskTotalCount | Uint64 | 风险实例个数 示例值： 10 |
| Risks | String | 风险实例详情列表，需要json decode 示例值： 无 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.ParamError | 参数错误。 |
| InternalError.System | 系统错误。 |
| InternalError.DependsDb | 依赖的db出错。 |
| InvalidParameter | 参数错误。 |
| InternalError | 内部错误。 |
| ResourceNotFound | 资源不存在。 |
| InvalidParameterValue | 参数取值错误。 |