ListScenes - Artificial Intelligence Recommendation - Alibaba Cloud Documentation Center

Operation description

You can use the Scenario Management feature in the console to manage scenarios. Do not use API operations for this purpose. For more information, see

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:ListScenes

get

*Instance

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	airec-cn-o400whm78004

Request parameters

Parameter	Type	Required	Description	Example
status	string	No	The status of the scenario. DRAFT: The scenario is a draft. PUBLISHING: The scenario is being published. RUNNING: The scenario is running. FAILED: The scenario failed to be published. FROZEN: The scenario is frozen.	1
sceneId	string	No	The scenario ID.	test
page	integer	No	The page number. Default value: 1.	1
size	integer	No	The number of entries to return on each page. Default value: 10. Valid values: 1 to 50.	10

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.
sceneId	string	The scenario ID.	test
gmtModified	string	The time when the scenario was last modified.	2020-04-23T06:08:48.000Z
status	string	The status of the scenario. DRAFT: The scenario is a draft. PUBLISHING: The scenario is being published. RUNNING: The scenario is running. FAILED: The scenario failed to be published. FROZEN: The scenario is frozen.	1
gmtCreate	string	The time when the scenario was created.	2020-04-23T06:08:48.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": [
    {
      "sceneId": "test",
      "gmtModified": "2020-04-23T06:08:48.000Z",
      "status": "1",
      "gmtCreate": "2020-04-23T06:08:48.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.