All Products
Search
Document Center

Data Management:ListScenarios

Last Updated:Oct 21, 2024

Queries business scenarios.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
TidlongNo

The ID of the tenant.

Note : To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see View information about the current tenant.
3***

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

7FAD400F-7A5C-4193-8F9A-39D86C4F0231
ErrorCodestring

The error code returned if the request failed.

UnknownError
ErrorMessagestring

The error message returned if the request failed.

UnknownError
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
ScenarioListarray<object>

The details of the returned business scenarios.

Scenarioobject
Idlong

The ID of the business scenario.

41***
ScenarioNamestring

The name of the business scenario.

test
CreatorIdstring

The ID of the user who created the business scenario.

23***
Descriptionstring

The description of the business scenario.

test

Examples

Sample success responses

JSONformat

{
  "RequestId": "7FAD400F-7A5C-4193-8F9A-39D86C4F0231",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "ScenarioList": [
    {
      "Id": 0,
      "ScenarioName": "test",
      "CreatorId": "23***",
      "Description": "test"
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history