分页查看场景列表

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListScene

系统规定参数。取值:ListScene

Name String 场景A

主场景名称

ProjectId String 1234****

所有项目ID

PageNum Long 1

页码

PageSize Long 20

页长

返回数据

名称 类型 示例值 描述
RequestId String 4F882EA7-3A1D-0113-94E4-70162C4B***

请求ID,与入参requestId对应

Code Long 200

返回码

Success Boolean true

是否请求成功

Message String success

错误消息

HasNext Boolean true

是否有下一页

CurrentPage Long 1

当前页

TotalPage Long 5

总页数

Count Long 100

数据总数

List Array of list

主场景数据

Id String 1234****

主场景ID

Name String 场景A

场景名称

Type String MODEL_3D

场景类型

SubSceneNum Long 20

子场景数

SourceNum Long 20

资源数

Published Boolean false

是否已发布 true:已发布:false:未发布

GmtCreate Long 1621236933677

创建时间

GmtModified Long 1621236933677

最后修改时间

PreviewToken String d989623696ab4f87a80b8d5b0b00****

预览Token

CoverUrl String www.example.com/xxxx/xxx.jpg

封面地址(模型)

Status String init

场景状态,init:初始化,published:已发布,publishing:发布中,copying:复制中,making:制作中,publishable:构建成功,makeFailed:制作失败

StatusName String 初始化

状态名称

示例

请求示例

Config config = new Config();
        config.setAccessKeyId("yourAccessKeyId");
        config.setAccessKeySecret("yourAccessKeySecret");
        config.setEndpoint("lyj.cn-hangzhou.aliyuncs.com");

        Client client = new Client(config);

        ListSceneRequest request = new ListSceneRequest();
        request.setName("name");
        request.setPageNum(1L);
        request.setPageSize(20L);
        request.setProjectId(“1234****”);

        ListSceneResponse response = client.listScene(request);
        if (response.getBody().success){
            // ...
        }

正常返回示例

XML格式

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

<ListSceneResponse>
    <RequestId>4F882EA7-3A1D-0113-94E4-70162C4B***</RequestId>
    <Code>200</Code>
    <Success>true</Success>
    <Message>success</Message>
    <HasNext>true</HasNext>
    <CurrentPage>1</CurrentPage>
    <TotalPage>5</TotalPage>
    <Count>100</Count>
    <List>
        <Id>1234****</Id>
        <Name>场景A</Name>
        <Type>MODEL_3D</Type>
        <SubSceneNum>20</SubSceneNum>
        <SourceNum>20</SourceNum>
        <Published>false</Published>
        <GmtCreate>1621236933677</GmtCreate>
        <GmtModified>1621236933677</GmtModified>
        <PreviewToken>d989623696ab4f87a80b8d5b0b00****</PreviewToken>
        <CoverUrl>www.example.com/xxxx/xxx.jpg</CoverUrl>
        <Status>init</Status>
        <StatusName>初始化</StatusName>
    </List>
</ListSceneResponse>

JSON格式

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

{
  "RequestId" : "4F882EA7-3A1D-0113-94E4-70162C4B***",
  "Code" : 200,
  "Success" : true,
  "Message" : "success",
  "HasNext" : true,
  "CurrentPage" : 1,
  "TotalPage" : 5,
  "Count" : 100,
  "List" : [ {
    "Id" : "1234****",
    "Name" : "场景A",
    "Type" : "MODEL_3D",
    "SubSceneNum" : 20,
    "SourceNum" : 20,
    "Published" : false,
    "GmtCreate" : 1621236933677,
    "GmtModified" : 1621236933677,
    "PreviewToken" : "d989623696ab4f87a80b8d5b0b00****",
    "CoverUrl" : "www.example.com/xxxx/xxx.jpg",
    "Status" : "init",
    "StatusName" : "初始化"
  } ]
}

错误码

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