文档

ListPtsScene - 分页查询场景

更新时间:

分页查询场景概览信息。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
pts:ListPtsScene
  • 全部资源
    *

请求参数

名称类型必填描述示例值
PageNumberinteger

第几页,取值范围 1~1073741824。

1
PageSizeinteger

每页显示场景条数,取值范围 10~1000。

10
KeyWordstring

关键字,可以通过对场景名 SceneName 进行模糊搜索或者对场景 IDSceneId 进行精确搜索。

测试下单

返回参数

名称类型描述示例值
object
Messagestring

错误提示信息,若成功则不返回任何数据。

创建或者修改场景入参必须是实体类scene的JSON串
RequestIdstring

请求 ID。

DD6F2ED8-E31B-497F-85AB-C4E358A5F667
HttpStatusCodeinteger

HTTP 状态码,若成功则不返回任何数据。

400
SceneViewListarray<object>

查询的场景列表信息。

object
CreateTimestring

场景创建时间。

2021-02-26 15:28:39
SceneIdstring

场景 ID。

DFGVS3S
SceneNamestring

场景名。

测试下单线上
Statusstring

PTS 场景状态

Draft:草稿 WaitStart:待启动 Debugging:调试中 Running:运行中
Codestring

系统状态码,若成功则不返回任何数据。

4001
Successboolean

是否成功。

  • true:成功
  • false:失败
false

示例

正常返回示例

JSON格式

{
  "Message": "创建或者修改场景入参必须是实体类scene的JSON串",
  "RequestId": "DD6F2ED8-E31B-497F-85AB-C4E358A5F667",
  "HttpStatusCode": 400,
  "SceneViewList": [
    {
      "CreateTime": "2021-02-26 15:28:39",
      "SceneId": "DFGVS3S",
      "SceneName": "测试下单线上",
      "Status": "Draft:草稿\nWaitStart:待启动\nDebugging:调试中\nRunning:运行中\n"
    }
  ],
  "Code": "4001",
  "Success": false
}

错误码

HTTP status code错误码错误信息
400ListPtsSceneFailKeyword length cannot exceed 30 characters

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

变更历史

变更时间变更内容概要操作
2024-03-07OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情