Query a list of rules using the ListRules API - Artificial Intelligence Recommendation

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

airec:ListRules

get

*Instance

acs:airec:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request syntax

GET /v2/openapi/instances/{instanceId}/rules HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	airec-cn-o400whm78004
sceneId	string	Yes	The ID of the scenario to which the rule belongs. Enter global to modify a global rule.	scenetest
ruleType	string	Yes	selection: Product selection rule. operation: Operational rule.	selection
status	string	No	DRAFT: Draft EFFECTIVE: Effective PUBLISHING: Publishing INEFFECTIVE: Invalid FAILED: Failed	EFFECTIVE
page	integer	No	The page number. The default value is 1.	1
size	integer	No	The number of entries per page. The default value is 10. The value must be in the range of 1 to 50.	10
startTime	integer	No	The start time. This is a UNIX timestamp in seconds.	1567584765
endTime	integer	No	The end time. This is a UNIX timestamp in seconds.	1567584765

Response elements

Element	Type	Description	Example
	object	The details of the result.
result	array<object>	The details of the result.
	object	The details of the result.
ruleId	string	The rule ID.	98493A14-D619-4E88-9F8D-108939817F9F
gmtModified	string	The time when the rule was last modified.	2020-04-27T06:38:28.000Z
status	string	DRAFT: Draft EFFECTIVE: Effective PUBLISHING: Publishing INEFFECTIVE: Invalid FAILED: Failed	draft
gmtCreate	string	The time when the rule was created.	2020-04-27T06:38:28.000Z
code	string	The error code.	InternalServerError
requestId	string	The request ID.	8F81A922-6C81-46D6-B78C-CC35E16B1691
message	string	The error details.	An internal server error occurred

Examples

Success response

JSON format

{
  "result": [
    {
      "ruleId": "98493A14-D619-4E88-9F8D-108939817F9F",
      "gmtModified": "2020-04-27T06:38:28.000Z",
      "status": "draft",
      "gmtCreate": "2020-04-27T06:38:28.000Z"
    }
  ],
  "code": "InternalServerError",
  "requestId": "8F81A922-6C81-46D6-B78C-CC35E16B1691",
  "message": "An internal server error occurred"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.