DescribeHybridMonitorNamespaceList - - Alibaba Cloud ドキュメントセンター

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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeHybridMonitorNamespaceList	The operation that you want to perform. Set the value to DescribeHybridMonitorNamespaceList.
PageSize	Integer	No	10	The number of entries to return on each page. A minimum of 1 entry can be returned on each page. Default value: 10.
PageNumber	Integer	No	1	The number of the page to return. Pages start from page 1. Default value: 1.
Keyword	String	No	aliyun	The keyword that is used to search for namespaces.
Namespace	String	No	aliyun-test	The name of the namespace. The name can contain uppercase letters, lowercase letters, digits, and hyphens (-).
ShowTaskStatistic	Boolean	No	false	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 value)

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

Response parameters


Parameter	Type	Example	Description
RequestId	String	1EC450A4-3221-5148-B77E-2827576CFE48	The ID of the request.
Success	String	true	Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.
Code	String	Success	The returned message.
Message	String	Specified parameter PageSize is not valid.	The error message.
PageSize	Integer	10	The number of entries returned per page.
PageNumber	Integer	1	The page number of the returned page.
Total	Integer	1	The total number of returned entries.
DescribeHybridMonitorNamespace	Array of DescribeHybridMonitorNamespace		The details of the namespaces.
Description	String	aliyun-test	The description of the namespace.
CreateTime	String	1652682744000	The timestamp that was generated when the namespace was created. Unit: milliseconds.
Namespace	String	aliyun-test	The name of the namespace.
IsDelete	Integer	0	Indicates whether the namespace is deleted. Valid values: 0: The namespace is not deleted. 1: The namespace is deleted.
Id	String	3****	The ID of the namespace.
ModifyTime	String	1652682744000	The timestamp that was generated when the namespace was last modified.
Detail	Object		The details of the data retention period.
Spec	String	cms.s1.3xlarge	The data retention period. Valid values: cms.s1.large: Data is stored for 15 days. cms.s1.xlarge: Data is stored for 32 days. cms.s1.2xlarge: Data is stored for 63 days. cms.s1.3xlarge: Data is stored for 93 days. cms.s1.6xlarge: Data is stored for 185 days. cms.s1.12xlarge: Data is stored for 376 days.
NotAliyunTaskNumber	Long	0	The number of metric import tasks for third-party services.
AliyunProductMetricList	Array of AliyunProductMetric		The configuration details of metric import tasks for Alibaba Cloud services.
UserId	Long	120886317861****	The account that is used to create the namespace.
NamespaceList	Array of Namespace		The list of namespaces.
Namespace	String	acs_ecs_dashboard	The namespace for the Alibaba Cloud service.
MetricList	Array of Metric		The list of metrics for the Alibaba Cloud service.
Period	Long	60	The interval at which metrics are collected. Unit: seconds.
List	Array of String	["cpu_total"]	The metrics.
YAMLConfig	String	products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total dimension: ''	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 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.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeHybridMonitorNamespaceList
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeHybridMonitorNamespaceListResponse>
	<RequestId>1EC450A4-3221-5148-B77E-2827576CFE48</RequestId>
	<PageSize>10</PageSize>
	<PageNumber>1</PageNumber>
	<Total>1</Total>
	<DescribeHybridMonitorNamespace>
		<ModifyTime>1652682744000</ModifyTime>
		<Description></Description>
		<CreateTime>1652682744000</CreateTime>
		<IsDelete>0</IsDelete>
		<Id>3****</Id>
		<Namespace>aliyun-test</Namespace>
		<Detail>
			<Spec>cms.s1.3xlarge</Spec>
		</Detail>
	</DescribeHybridMonitorNamespace>
	<Code>Success</Code>
	<Success>true</Success>
</DescribeHybridMonitorNamespaceListResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "1EC450A4-3221-5148-B77E-2827576CFE48",
  "PageSize" : 10,
  "PageNumber" : 1,
  "Total" : 1,
  "DescribeHybridMonitorNamespace" : [ {
    "ModifyTime" : 1652682744000,
    "Description" : "",
    "CreateTime" : 1652682744000,
    "IsDelete" : 0,
    "Id" : "3****",
    "Namespace" : "aliyun-test",
    "Detail" : {
      "Spec" : "cms.s1.3xlarge"
    }
  } ],
  "Code" : "Success",
  "Success" : true
}

Error codes

For a list of error codes, see Service error codes.