DescribeExporterRuleList-阿里云帮助中心

Queries the list of data export rules by calling the DescribeExporterRuleList operation.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cms:DescribeExporterRuleList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page.	10

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	6BA047CA-8BC6-40BC-BC8F-FBECF35F1993
Success	boolean	Indicates whether the call was successful. Valid values: `true`: Successful. `false`: Failed.	true
Code	string	The status code. Note A value of 200 indicates success. Any other value indicates failure.	200
Message	string	The returned message.	The specified resource is not found.
PageNumber	integer	The page number. Default value: 1.	1
Total	integer	The total number of records.	1000
Datapoints	object
Datapoint	array<object>	The data point.
	array<object>	The data point.
MetricName	string	The name of the metric.	CPUUtilization
Describe	string	The description of the export rule.	export test
TargetWindows	string	The time window for data exporting. Unit: seconds. Note To specify multiple time windows, separate them with commas (,). Data cannot be exported for a time window shorter than 60 seconds.	rule_test
CreateTime	integer	The time when the rule was created.	1667526533000
Enabled	boolean	Indicates whether the rule is enabled.	true
Dimension	string	The dimension.	hotsName
Namespace	string	The namespace of the cloud service.	acs_ecs_dashboard
RuleName	string	The name of the rule.	L121-InsurancePolicy-DefaultEventRule
DstName	object
DstName	array	The destination name.
	string	The destination name.	[]

Examples

Success response

JSON format

{
  "RequestId": "6BA047CA-8BC6-40BC-BC8F-FBECF35F1993",
  "Success": true,
  "Code": "200",
  "Message": "The specified resource is not found.",
  "PageNumber": 1,
  "Total": 1000,
  "Datapoints": {
    "Datapoint": [
      {
        "MetricName": "CPUUtilization",
        "Describe": "export test",
        "TargetWindows": "rule_test",
        "CreateTime": 1667526533000,
        "Enabled": true,
        "Dimension": "hotsName",
        "Namespace": "acs_ecs_dashboard",
        "RuleName": "L121-InsurancePolicy-DefaultEventRule",
        "DstName": {
          "DstName": [
            "[]"
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	ParameterInvalid	Illegal parameters.
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.