You can call this operation to query the list of data export rules.

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 DescribeExporterRuleList

The operation that you want to perform. Set the value to DescribeExporterRuleList.

PageNumber Integer No 1

The number of the page to return. Default value: 1.
PageSize Integer No 1000

The number of entries to return on each page. Default value: 1000.

Response parameters

Parameter Type Example Description
Total Integer 1000

The total number of entries returned.
Code String 200

The status code.

Note The status code 200 indicates a successful call, whereas any other status code indicates a failed call.
Success Boolean true

Indicates whether the operation was successful. Valid values:

  • true: indicates that the operation was successful.
  • false: indicates that the operation failed.
RequestId String 6BA047CA-8BC6-40BC-BC8F-FBECF35F1993

The ID of the request.
Message String success

The returned message.
Datapoints Array

The list of data export rules.
Datapoint
CreateTime Long 1584024616228

The UNIX timestamp when the rule is created.
Describe String Export monitoring data

The description of the rule.
Dimension String {"instanceId":"xxxxx"}

The associated resources.
DstName List exporter1

The name of the destination to which the data is exported.
Enabled Boolean true

Indicates whether the rule is enabled.
MetricName String cpu_total

The name of the metric.

Note For more information, see DescribeMetricMetaList or Preset metrics reference.
Namespace String acs_ecs_dashboard

The namespace of the monitored service.

Note For more information, see DescribeMetricMetaList or Preset metrics reference.
RuleName String myRuleName

The name of the data export rule.

TargetWindows String 60,300

The time window of the exported data.

Separate multiple windows with commas (,).

Note Data in a time window of less than 60 seconds cannot be exported.
PageNumber Integer 1

The number of the returned page.

Examples

Sample requests

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

Sample success responses

XML format 

<RequestId>6BA047CA-8BC6-40BC-BC8F-FBECF35F1993</RequestId>
<PageNumber>1</PageNumber>
<Total>1</Total>
<Datapoints>
    <Datapoint>
        <TargetWindows>60,300</TargetWindows>
        <Describe/>
        <MetricName>cpu_total</MetricName>
        <CreateTime>1584024616228</CreateTime>
        <Enabled>false</Enabled>
        <Dimension>{'userId': '177******'}</Dimension>
        <DstName>
            <DstName>exporter1</DstName>
        </DstName>
        <RuleName>exporterRule1</RuleName>
        <Namespace>acs_ecs_dashboard</Namespace>
        <dstNames/>
    </Datapoint>
</Datapoints>
<Code>200</Code>
<Success>true</Success>

JSON format 

{
	"RequestId": "6BA047CA-8BC6-40BC-BC8F-FBECF35F1993",
	"PageNumber": 1,
	"Total": 1,
	"Datapoints": {
		"Datapoint": [
			{
				"TargetWindows": "60,300",
				"Describe": "",
				"MetricName": "cpu_total",
				"CreateTime": 1584024616228,
				"Enabled": false,
				"Dimension": "{'userId': '177******'}",
				"DstName": {
					"DstName": [
						"exporter1"
					]
				},
				"RuleName": "exporterRule1",
				"Namespace": "acs_ecs_dashboard",
				"dstNames": ""
			}
		]
	},
	"Code": "200",
	"Success": true
}

Error codes

For a list of error codes, visit the API Error Center.