Queries the business scenarios.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListScenarios

The operation that you want to perform. Set the value to ListScenarios.

Tid Long No 3***

The ID of the tenant.

Note The ID of the tenant is displayed when you move the pointer over the profile picture in the upper-right corner of the DMS console. For more information, see the View information about the current tenant section of the Manage DMS tenants topic.

Response parameters

Parameter Type Example Description
RequestId String 7FAD400F-7A5C-4193-8F9A-39D86C4F0231

The ID of the request.

ErrorCode String UnknownError

The error code returned if the request failed.

ErrorMessage String UnknownError

The error message returned if the request failed.

Success Boolean true

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
ScenarioList Array of Scenario

The list of business scenarios.

Id Long 41***

The ID of the business scenario.

ScenarioName String test

The name of the business scenario.

CreatorId String 23***

The ID of the user who created the business scenario.

Description String test

The description of the business scenario.

Examples

Sample requests

http(s)://dms-enterprise.aliyuncs.com/?Action=ListScenarios
&Tid=3***
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<ListScenariosResponse>
    <RequestId>7FAD400F-7A5C-4193-8F9A-39D86C4F0231</RequestId>
    <Success>true</Success>
    <ScenarioList>
        <ScenarioName>test</ScenarioName>
        <CreatorId>23***</CreatorId>
        <Description>test</Description>
    </ScenarioList>
</ListScenariosResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, visit the API Error Center.