DescribeHybridMonitorNamespaceList - CloudMonitor - Alibaba Cloud Documentation Center

Queries namespaces and the details of the related metric import tasks.

Operation description

In this example, all namespaces within the current account are queried. The response shows that the current account has only one namespace named aliyun-test.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	The number of entries per page. Page numbers start from 1. Default value: 10.	10
PageNumber	integer	No	The page number. Page numbers start from 1. Default value: 1.	1
Keyword	string	No	The search keyword.	aliyun
Namespace	string	No	The name of the namespace. The name can contain letters, digits, and hyphens (-).	aliyun-test
ShowTaskStatistic	boolean	No	Specifies whether to return the configuration details of metric import tasks for Alibaba Cloud services and the number of metric import tasks for third-party services. Valid values: true false (default)	false

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

Response parameters

Parameter	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	1EC450A4-3221-5148-B77E-2827576CFE48
Success	string	Indicates whether the request was successful. Valid values: true false	true
Code	string	The response code.	Success
Message	string	The returned message.	Specified parameter PageSize is not valid.
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
Total	integer	The total number of entries returned.	1
DescribeHybridMonitorNamespace	object []	The details of the namespaces.
Description	string	The description of the namespace.	aliyun-test
CreateTime	string	The timestamp that was generated 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 ID of the namespace.	3****
ModifyTime	string	The timestamp that was generated when the namespace was last modified.	1652682744000
Detail	object	The details of the data retention period.
Spec	string	The data retention period. Valid values: cms.s1.large (Retention Period 15 Days) cms.s1.xlarge (Retention Period 32 Days) cms.s1.2xlarge (Retention Period 63 Days) cms.s1.3xlarge (Retention Period 93 Days) cms.s1.6xlarge (Retention Period 185 Days) cms.s1.12xlarge (Retention Period 367 Days)	cms.s1.3xlarge
NamespaceRegion	string	The region where the metric data is stored. Note This parameter is returned if you select `m_prom_user` for `NamespaceType` when you create a namespace.	cn-hangzhou
SLSProject	string	The project where the metric data is located. Note This parameter is returned if you select `m_prom_user` for `NamespaceType` when you create a namespace.	cms-hybrid-120886317861****-cn-hangzhou-a83d
NotAliyunTaskNumber	long	The number of metric import tasks for third-party services.	0
AliyunProductMetricList	object []	The configuration details of metric import tasks for Alibaba Cloud services.
UserId	long	The account that is used to create the namespace.	120886317861****
NamespaceList	object []	The namespaces.
Namespace	string	The namespace for the Alibaba Cloud service.	acs_ecs_dashboard
MetricList	object []	The metrics for the Alibaba Cloud service.
Period	long	The collection period of the metric. Unit: seconds.	60
List	array	The metrics.
	string	The metric.	["cpu_total"]
YAMLConfig	string	The configuration file of the Alibaba Cloud service that you want to monitor by using 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 you want to monitor by using Hybrid Cloud Monitoring. If you do not specify a dimension, all resources of the Alibaba Cloud service are monitored.	products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total dimension: ''
NamespaceType	string	The storage scheme of metric data. Valid values: m_prom_user: The metric data is stored in Simple Log Service. m_prom_pool: The metric data is stored in the storage space provided by CloudMonitor.	m_prom_user

Examples

Sample success responses

JSONformat

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

Error codes

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

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-11-21

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 403
	delete Error Codes: 404
	delete Error Codes: 409
	delete Error Codes: 500
Output Parameters	The response structure of the API has changed.

2021-10-25

Add Operation

see changesets