DescribeHybridMonitorNamespaceList - 查询指标仓库列表 - 云监控

调用DescribeHybridMonitorNamespaceList接口查询指标仓库列表，及其接入数据详情。

接口说明

本文将提供一个示例，查询当前账号下的所有指标仓库。返回结果显示，当前账号下只有一个指标仓库aliyun-test。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
cms:DescribeCustomNamespace	create	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
PageSize	integer	否	分页时每页显示的数据行数。起始值：1。默认值：10。	10
PageNumber	integer	否	页码。起始值：1。默认值：1。	1
Keyword	string	否	搜索关键字。	aliyun
Namespace	string	否	指标仓库名称。格式：由大写字母、小写字母、数字和短划线（-）组成。	aliyun-test
ShowTaskStatistic	boolean	否	是否显示阿里云产品的数据接入任务的配置详情和非阿里云产品的数据接入任务数量。取值： true：显示。 false（默认值）：不显示。	false

关于公共请求参数的详情，请参见公共参数。

返回参数

名称	类型	描述	示例值
	object	无。
RequestId	string	请求 ID。	1EC450A4-3221-5148-B77E-2827576CFE48
Success	string	操作是否成功。取值： true：成功。 false：失败。	true
Code	string	调用结果。	Success
Message	string	错误信息。	Specified parameter PageSize is not valid.
PageSize	integer	分页时每页显示的数据行数。	10
PageNumber	integer	页码。	1
Total	integer	总记录条数。	1
DescribeHybridMonitorNamespace	array<object>	指标仓库详情。
	object	无。
Description	string	指标仓库描述。	aliyun-test
CreateTime	string	创建指标仓库的时间戳。单位：毫秒。	1652682744000
Namespace	string	指标仓库名称。	aliyun-test
IsDelete	integer	指标仓库是否已删除。取值： 0：未删除。 1：已删除。	0
Id	string	指标仓库 ID。	3****
ModifyTime	string	最后一次修改指标仓库的时间戳。	1652682744000
Detail	object	数据存储时长的详情。
Spec	string	数据存储时长。取值： cms.s1.large：数据存储时长 15 天。 cms.s1.xlarge：数据存储时长 32 天。 cms.s1.2xlarge：数据存储时长 63 天。 cms.s1.3xlarge：数据存储时长 93 天。 cms.s1.6xlarge：数据存储时长 185 天。 cms.s1.12xlarge：数据存储时长 376 天。	cms.s1.3xlarge
NamespaceRegion	string	监控数据存储的地域。说明当您创建指标仓库时，如果`NamespaceType`选择`m_prom_user`，则显示该参数。	cn-hangzhou
SLSProject	string	监控数据所在的日志项目。说明当您创建指标仓库时，如果`NamespaceType`选择`m_prom_user`，则显示该参数。	cms-hybrid-120886317861****-cn-hangzhou-a83d
NotAliyunTaskNumber	long	非阿里云产品的数据接入任务数量。	0
AliyunProductMetricList	array<object>	阿里云产品的数据接入任务的配置详情。
	object	无。
UserId	long	创建指标仓库的账号。	120886317861****
NamespaceList	array<object>	指标仓库列表。
	object	无。
Namespace	string	阿里云产品数据命名空间。	acs_ecs_dashboard
MetricList	array<object>	阿里云产品的监控项列表。
	object	无。
Period	long	监控项的采集周期。单位：秒。	60
List	array	监控项列表。
	string	监控项。	["cpu_total"]
YAMLConfig	string	接入企业云监控的阿里云产品的配置文件。 namespace：阿里云产品的命名空间。 metric_list：阿里云服务的监控项。 dimension：企业云监控支持查询的阿里云服务的资源。dimension 为空，表示监控所有资源。	products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total dimension: ''
NamespaceType	string	监控数据的存储方案。取值： m_prom_user：监控数据存储在日志服务中。 m_prom_pool：监控数据存储在云监控提供的存储空间中。	m_prom_user

示例

正常返回示例

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"
      },
      "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": "m_prom_user"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息
400	%s	%s
409	%s	Resources already exist.
500	InternalError	%s

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2023-11-21	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2021-10-25	新增 OpenAPI	查看变更详情