1. 接口描述
接口请求域名: monitor.tencentcloudapi.com 。
查询所有名字空间
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeAllNamespaces。 |
Version | 是 | String | 公共参数,本接口取值:2018-07-24。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
SceneType | 是 | String | 根据使用场景过滤 目前仅有"ST_ALARM"=告警类型 示例值:ST_ALARM |
Module | 是 | String | 固定值,为"monitor" 示例值:monitor |
MonitorTypes.N | 否 | Array of String | 根据监控类型过滤 不填默认查所有类型 "MT_QCE"=云产品监控 示例值:["MT_QCE"] |
Ids.N | 否 | Array of String | 根据namespace的Id过滤 不填默认查询所有 示例值:cvm_device |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
QceNamespaces | CommonNamespace | 云产品的告警策略类型,已废弃 |
CustomNamespaces | CommonNamespace | 其他告警策略类型,已废弃 |
QceNamespacesNew | Array of CommonNamespace | 云产品的告警策略类型 |
CustomNamespacesNew | Array of CommonNamespace | 其他告警策略类型,暂不支持 |
CommonNamespaces | Array of CommonNamespaceNew | 通用告警策略类型(包括:应用性能监控,前端性能监控,云拨测) 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获得所有名字空间
输入示例
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAllNamespaces
<公共请求参数>
{
"Module": "monitor",
"MonitorTypes": [
"MT_QCE"
],
"SceneType": "ST_ALARM"
}
输出示例
{
"Response": {
"QceNamespaces": {
"Id": "",
"Name": "",
"ProductName": "",
"Value": "",
"Config": "",
"AvailableRegions": [],
"DashboardId": "",
"SortId": 0
},
"QceNamespacesNew": [
{
"Id": "xxxxxxx",
"Name": "专线接入-专用通道",
"ProductName": "专线接入-专用通道",
"Value": "qce/dcx",
"Config": "……",
"AvailableRegions": [
"gz",
"sh"
],
"DashboardId": "dcchannel",
"SortId": 500
}
],
"CustomNamespaces": {
"Id": "",
"Name": "",
"ProductName": "",
"Value": "",
"Config": "",
"AvailableRegions": [],
"DashboardId": "",
"SortId": 0
},
"CustomNamespacesNew": [
{
"Id": "=wenlong_sidecar",
"Name": "=wenlong_sidecar",
"ProductName": "=wenlong_sidecar",
"Value": "=wenlong_sidecar",
"Config": "",
"AvailableRegions": [],
"DashboardId": "=wenlong_sidecar",
"SortId": 0
}
],
"CommonNamespaces": [
{
"Id": "performance_metric",
"MonitorType": "MT_TAW",
"Name": "性能指标",
"Dimensions": []
}
],
"RequestId": "d96ec542-6547-4af2-91ac-fee85c1b8b85"
}
}
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.DoHTTPTransferFailed | 后端服务超时 |
UnsupportedOperation | 操作不支持。 |