All Products
Search
Document Center

:ListScenes

Last Updated:Mar 01, 2024

Queries scenes of a specified instance.

Operation description

We recommend that you do not call an API operation to manage scenes. Go to the Scenario Building page in the AIRec console to manage scenes.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

GET /openapi/instances/{airec-xxxx}/scenes

airec-cn-o400whm78004
statusstringNo
1
sceneIdstringNo

The ID of the instance.

test
pageintegerNo

Specifies whether the item can be recommended.

1
sizeintegerNo

The ID of the scene.

10

Response parameters

ParameterTypeDescriptionExample
object
resultobject []

The number of the page to return. Default value: 1.

sceneIdstring

The number of entries to return on each page. Valid values: 1 to 50. Default value: 10.

test
gmtModifiedstring

The returned result.

2020-04-23T06:08:48.000Z
statusstring

The ID of the scene.

1
gmtCreatestring

The time when the scene was last modified.

2020-04-23T06:08:48.000Z
codestring

Indicates whether the item can be recommended.

InternalServerError
requestIdstring

The time when the scene was created.

8F81A922-6C81-46D6-B78C-CC35E16B1691
messagestring

The error code.

An internal server error occurred

Examples

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history