1. 接口描述
接口请求域名: advisor.tencentcloudapi.com 。
用于查询评估项的信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeStrategies。 |
Version | 是 | String | 公共参数,本接口取值:2020-07-21。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Strategies | Array of Strategies | 评估项列表 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询评估项信息
输入示例
POST / HTTP/1.1
Host: advisor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeStrategies
<公共请求参数>
{}
输出示例
{
"Response": {
"RequestId": "111",
"Strategies": [
{
"StrategyId": 131,
"Name": "云数据库(Redis)跨可用区部署",
"Desc": "检查 Redis 实例是否跨可用区部署,如果实例未跨可用区部署,当实例出现可用区级别的灾难故障时,可能造成实例无法访问风险",
"Product": "redis",
"ProductDesc": "云数据库(Redis)",
"Repair": "如果业务有较高容灾需求,建议采用跨可用区部署方案,提升业务可靠性,[跨可用区分布操作指引](https://cloud.tencent.com/document/product/239/51113)",
"GroupId": 2,
"GroupName": "可靠",
"Conditions": [
{
"ConditionId": 178,
"Level": 2,
"LevelDesc": "中风险",
"Desc": "Redis 实例未跨可用区部署"
}
]
},
{
"StrategyId": 235,
"Name": "云数据库(Redis)使用基础网络",
"Desc": "检查 Redis 是否使用基础网络",
"Product": "redis",
"ProductDesc": "云数据库(Redis)",
"Repair": "建议更换为私有网络,私有网络是一块逻辑隔离的网络空间,基础网络是腾讯云上所有用户的公共网络资源池",
"GroupId": 2,
"GroupName": "可靠",
"Conditions": [
{
"ConditionId": 307,
"Level": 2,
"LevelDesc": "中风险",
"Desc": "实例使用基础网络"
}
]
}
]
}
}
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.DependsDb | 依赖的db出错。 |
InternalError.System | 系统错误。 |
InvalidParameter | 参数错误。 |
ResourceNotFound | 资源不存在。 |