1. 接口描述
接口请求域名: monitor.tencentcloudapi.com 。
查询腾讯云可观测平台云产品列表,支持云服务器CVM、云数据库、云消息队列、负载均衡、容器服务、专线等云产品。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeProductList。 |
Version | 是 | String | 公共参数,本接口取值:2018-07-24。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Module | 是 | String | 固定传值monitor 示例值:monitor |
Order | 否 | String | 排序方式:DESC/ASC(区分大小写),默认值DESC 示例值:DESC |
Offset | 否 | Integer | 分页查询的偏移量,默认值0 示例值:0 |
Limit | 否 | Integer | 分页查询的每页数据量,默认值20 示例值:5 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ProductList | Array of ProductSimple | 产品信息列表 注意:此字段可能返回 null,表示取不到有效值。 |
TotalCount | Integer | 产品总数 注意:此字段可能返回 null,表示取不到有效值。 示例值:294 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 分页查询产品列表
查询腾讯云可观测平台产品列表
输入示例
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProductList
<公共请求参数>
{
"Limit": "5",
"Module": "monitor",
"Offset": "0"
}
输出示例
{
"Response": {
"ProductList": [
{
"ProductName": "私有网络-NAT网关",
"ProductEnName": "NAT Gateway",
"Namespace": "qce/nat_qos_stats"
},
{
"ProductName": "CDN-CDN域名国内",
"ProductEnName": "CDN-China_CDN_Domain",
"Namespace": "qce/cdn"
},
{
"ProductName": "CDN-CDN项目国内",
"ProductEnName": "CDN-China_CDN_Project",
"Namespace": "qce/cdn"
},
{
"ProductName": "云服务器-基础监控",
"ProductEnName": "Cloud Virtual Machine",
"Namespace": "qce/cvm"
},
{
"ProductName": "专线接入-物理专线",
"ProductEnName": "Physical dedicated line",
"Namespace": "qce/dc"
}
],
"RequestId": "28b84e33-8865-4cd3-a4ac-bdacccefbb2d",
"TotalCount": 446
}
}
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.AlertPolicyCreateFailed | 创建告警策略失败。 |
InternalError | 内部错误。 |
InternalError.ExeTimeout | 执行超时。 |
InvalidParameter | 参数错误。 |
InvalidParameter.InvalidParameter | 参数错误。 |
InvalidParameter.InvalidParameterParam | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
ResourceNotFound | 资源不存在。 |
UnsupportedOperation | 操作不支持。 |