调用DescribeHybridMonitorNamespaceList接口查询指标仓库列表,及其接入数据详情。
接口说明
本文将提供一个示例,查询当前账号下的所有指标仓库。返回结果显示,当前账号下只有一个指标仓库aliyun-test。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| PageSize |
integer |
否 |
分页时每页显示的数据行数。 起始值:1。默认值:10。 |
10 |
| PageNumber |
integer |
否 |
页码。 起始值:1。默认值:1。 |
1 |
| Keyword |
string |
否 |
搜索关键字。 |
aliyun |
| Namespace |
string |
否 |
指标仓库名称。 格式:由大写字母、小写字母、数字和短划线(-)组成。 |
aliyun-test |
| ShowTaskStatistic |
boolean |
否 |
是否显示阿里云产品的数据接入任务的配置详情和非阿里云产品的数据接入任务数量。取值:
|
false |
关于公共请求参数的详情,请参见公共参数。
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
无。 |
||
| RequestId |
string |
请求 ID。 |
1EC450A4-3221-5148-B77E-2827576CFE48 |
| Success |
string |
操作是否成功。取值:
|
true |
| Code |
string |
调用结果。 |
Success |
| Message |
string |
错误信息。 |
Specified parameter PageSize is not valid. |
| PageSize |
integer |
分页时每页显示的数据行数。 |
10 |
| PageNumber |
integer |
页码。 |
1 |
| Total |
integer |
总记录条数。 |
1 |
| DescribeHybridMonitorNamespace |
array<object> |
指标仓库详情。 |
|
|
array<object> |
无。 |
||
| Description |
string |
指标仓库描述。 |
aliyun-test |
| CreateTime |
string |
创建指标仓库的时间戳。 单位:毫秒。 |
1652682744000 |
| Namespace |
string |
指标仓库名称。 |
aliyun-test |
| IsDelete |
integer |
指标仓库是否已删除。取值:
|
0 |
| Id |
string |
指标仓库 ID。 |
3**** |
| ModifyTime |
string |
最后一次修改指标仓库的时间戳。 |
1652682744000 |
| Detail |
object |
数据存储时长的详情。 |
|
| Spec |
string |
数据存储时长。取值:
|
cms.s1.3xlarge |
| NamespaceRegion |
string |
监控数据存储的地域。 说明
当您创建指标仓库时,如果 |
cn-hangzhou |
| SLSProject |
string |
监控数据所在的日志项目。 说明
当您创建指标仓库时,如果 |
cms-hybrid-120886317861****-cn-hangzhou-a83d |
| PrometheusInstanceId |
string |
监控数据所在的 Prometheus 实例。 说明
当您创建指标仓库时,如果 |
rw-57******************7f |
| NotAliyunTaskNumber |
integer |
非阿里云产品的数据接入任务数量。 |
0 |
| AliyunProductMetricList |
array<object> |
阿里云产品的数据接入任务的配置详情。 |
|
|
array<object> |
无。 |
||
| UserId |
integer |
创建指标仓库的账号。 |
120886317861**** |
| NamespaceList |
array<object> |
指标仓库列表。 |
|
|
array<object> |
无。 |
||
| Namespace |
string |
阿里云产品数据命名空间。 |
acs_ecs_dashboard |
| MetricList |
array<object> |
阿里云产品的监控项列表。 |
|
|
object |
无。 |
||
| Period |
integer |
监控项的采集周期。 单位:秒。 |
60 |
| List |
array |
监控项列表。 |
|
|
string |
监控项。 |
["cpu_total"] |
|
| YAMLConfig |
string |
接入企业云监控的阿里云产品的配置文件。
|
products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total dimension: '' |
| NamespaceType |
string |
监控数据的存储方案。取值:
|
aliyun_prometheus |
示例
正常返回示例
JSON格式
{
"RequestId": "1EC450A4-3221-5148-B77E-2827576CFE48",
"Success": "true",
"Code": "Success",
"Message": "Specified parameter PageSize is not valid.",
"PageSize": 10,
"PageNumber": 1,
"Total": 1,
"DescribeHybridMonitorNamespace": [
{
"Description": "aliyun-test",
"CreateTime": "1652682744000",
"Namespace": "aliyun-test",
"IsDelete": 0,
"Id": "3****",
"ModifyTime": "1652682744000",
"Detail": {
"Spec": "cms.s1.3xlarge",
"NamespaceRegion": "cn-hangzhou",
"SLSProject": "cms-hybrid-120886317861****-cn-hangzhou-a83d",
"PrometheusInstanceId": "rw-57******************7f"
},
"NotAliyunTaskNumber": 0,
"AliyunProductMetricList": [
{
"UserId": 0,
"NamespaceList": [
{
"Namespace": "acs_ecs_dashboard",
"MetricList": [
{
"Period": 60,
"List": [
"[\"cpu_total\"]"
]
}
]
}
],
"YAMLConfig": "products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total dimension: ''"
}
],
"NamespaceType": "aliyun_prometheus"
}
]
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | %s | %s | |
| 500 | InternalError | %s | |
| 403 | %s | %s | |
| 404 | %s | %s | |
| 409 | %s | Resources already exist. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。