全部产品
Search
文档中心

数据管理 DMS:ListScenarios - 获取业务场景列表

更新时间:Aug 28, 2026

调用ListScenarios接口,获取业务场景列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dms:ListScenarios

list

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

Tid

integer

否

租户 ID。

说明

取自系统右上角头像处悬停展示的租户 ID 信息,详情请参见查看租户信息。

3***

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

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

ErrorCode

string

错误码。

UnknownError

ErrorMessage

string

调用失败时,返回的出错信息。

UnknownError

Success

boolean

请求是否成功,返回值如下:

  • true:请求成功。

  • false:请求失败。

true

ScenarioList

array<object>

业务场景列表。

object

Id

integer

业务场景 ID。

41***

ScenarioName

string

业务场景名称。

test

CreatorId

string

创建人的用户 ID。

23***

Description

string

业务场景描述。

test

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。