DescribeHybridMonitorNamespaceList - Cloud Monitor - Alibaba Cloud Documentation Center

Queries a list of namespaces and the details of their data sources.

Operation description

This example shows how to query all namespaces that belong to the current account. The response indicates that only one namespace, aliyun-test, exists.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	The number of entries to return on each page. Minimum value: 1. Default value: 10.	10
PageNumber	integer	No	The page number. Minimum value: 1. Default value: 1.	1
Keyword	string	No	The keyword for the search.	aliyun
Namespace	string	No	The name of the namespace. The name can contain uppercase letters, lowercase letters, digits, and hyphens (-).	aliyun-test
ShowTaskStatistic	boolean	No	Specifies whether to display the configuration details of data import tasks for Alibaba Cloud services and the number of data import tasks for non-Alibaba Cloud services. Valid values: true false (default)	false

For more information about common request parameters, see Common parameters.

Response elements

Element	Type	Description	Example
	object	No description is available.
RequestId	string	The request ID.	1EC450A4-3221-5148-B77E-2827576CFE48
Success	string	Indicates whether the operation was successful. Valid values: true: The operation was successful. false: The operation failed.	true
Code	string	The status code.	Success
Message	string	The error message.	Specified parameter PageSize is not valid.
PageSize	integer	The number of entries returned per page.	10
PageNumber	integer	The page number.	1
Total	integer	The total number of entries.	1
DescribeHybridMonitorNamespace	array<object>	The details of the namespaces.
	array<object>	No description is available.
Description	string	The description of the namespace.	aliyun-test
CreateTime	string	The timestamp when the namespace was created. Unit: milliseconds.	1652682744000
Namespace	string	The name of the namespace.	aliyun-test
IsDelete	integer	Indicates whether the namespace is deleted. Valid values: 0: The namespace is not deleted. 1: The namespace is deleted.	0
Id	string	The namespace ID.	3****
ModifyTime	string	The timestamp when the namespace was last modified. Unit: milliseconds.	1652682744000
Detail	object	The details of the data storage duration.
Spec	string	The data storage duration. Valid values: cms.s1.large: 15 days. cms.s1.xlarge: 32 days. cms.s1.2xlarge: 63 days. cms.s1.3xlarge: 93 days. cms.s1.6xlarge: 185 days. cms.s1.12xlarge: 376 days.	cms.s1.3xlarge
NamespaceRegion	string	The region where the monitoring data is stored. Note This parameter is returned if you set `NamespaceType` to `m_prom_user` when you create the namespace.	cn-hangzhou
SLSProject	string	The Simple Log Service (SLS) project where the monitoring data is stored. Note This parameter is returned if you set `NamespaceType` to `m_prom_user` when you create the namespace.	cms-hybrid-120886317861****-cn-hangzhou-a83d
PrometheusInstanceId	string	The Prometheus instance where the monitoring data is stored. Note This parameter is returned if you set `NamespaceType` to `aliyun_prometheus` when you create the namespace.	rw-57******************7f
NotAliyunTaskNumber	integer	The number of data import tasks for non-Alibaba Cloud services.	0
AliyunProductMetricList	array<object>	The configuration details of data import tasks for Alibaba Cloud services.
	array<object>	No description is available.
UserId	integer	The account that is used to create the namespace.	120886317861****
NamespaceList	array<object>	The list of namespaces.
	array<object>	No description is available.
Namespace	string	The data namespace of the Alibaba Cloud service.	acs_ecs_dashboard
MetricList	array<object>	The list of metrics for the Alibaba Cloud service.
	object	No description is available.
Period	integer	The collection period of the metric. Unit: seconds.	60
List	array	The list of metrics.
	string	The metric.	["cpu_total"]
YAMLConfig	string	The configuration file for the Alibaba Cloud service that is connected to Hybrid Cloud Monitoring. namespace: the namespace of the Alibaba Cloud service. metric_list: the metrics of the Alibaba Cloud service. dimension: the resources of the Alibaba Cloud service that can be queried in Hybrid Cloud Monitoring. If this parameter is empty, all resources are monitored.	products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total dimension: ''
NamespaceType	string	The storage solution for monitoring data. Valid values: m_prom_user: The monitoring data is stored in SLS. m_prom_pool: The monitoring data is stored in the storage space provided by Cloud Monitor. aliyun_prometheus: The monitoring data is stored in a Prometheus instance.	aliyun_prometheus

Examples

Success response

JSON format

{
  "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"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	%s	%s
500	InternalError	%s
403	%s	%s
404	%s	%s
409	%s	Resources already exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.