获取实例列表。注意参数以query param的方式传入。

调试

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

调试

请求参数

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

系统规定参数。取值：ListInstances。

ProjectId String 否 1

项目ID
InstanceName String 否 测试项目

实例名称，支持模糊搜索
PageSize Integer 否 10

每页显示多少条
CurrentPage Integer 否 1

当前页序号

返回数据

名称类型示例值描述
名称 类型 示例值 描述
Message String SUCCESS

错误信息
RequestId String D001BEB9-A281-4BF0-B595-512A5CBDC122

RequestID
Data Object

返回数据
Items Array of Items

返回数据条目
Status String ONLINED

实例状态：

  • APPROVED：待上线
  • INIT：上线中
  • ONLINED：已上线
  • OFFLINING：下线中
  • DEVELOPING：编辑中
InstanceName String test

实例名称
CreateTime Long 1617878024000

实例创建时间
DeviceNumber Integer 10

摄像机数量
InstanceId String 1111

实例ID
AcuUsed Integer 1

ACU使用数量
Algorithms Array of Algorithms

算法列表
AlgorithmName String 人脸算法

算法名称
AlgorithmId String 10000

算法ID
CurrentPage Integer 1

当前页序号
PageSize Integer 10

每页显示多少条;
TotalCount Integer 32

数据总数
Code String 0

返回code码
Success Boolean true

是否请求成功

示例

请求示例

http(s)://[Endpoint]/?Action=ListInstances
&ProjectId=1
&InstanceName=测试项目
&PageSize=10
&CurrentPage=1
&公共请求参数

正常返回示例

XML格式 

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

<ListInstancesResponse>
    <Message>SUCCESS</Message>
    <RequestId>D001BEB9-A281-4BF0-B595-512A5CBDC122</RequestId>
    <Data>
        <Items>
            <Status>ONLINED</Status>
            <InstanceName>test</InstanceName>
            <CreateTime>1617878024000</CreateTime>
            <DeviceNumber>10</DeviceNumber>
            <InstanceId>1111</InstanceId>
            <AcuUsed>1</AcuUsed>
            <Algorithms>
                <AlgorithmName>人脸算法</AlgorithmName>
                <AlgorithmId>10000</AlgorithmId>
            </Algorithms>
        </Items>
        <CurrentPage>1</CurrentPage>
        <PageSize>10</PageSize>
        <TotalCount>32</TotalCount>
    </Data>
    <Code>0</Code>
    <Success>true</Success>
</ListInstancesResponse>

JSON格式 

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

{
  "Message" : "SUCCESS",
  "RequestId" : "D001BEB9-A281-4BF0-B595-512A5CBDC122",
  "Data" : {
    "Items" : [ {
      "Status" : "ONLINED",
      "InstanceName" : "test",
      "CreateTime" : 1617878024000,
      "DeviceNumber" : 10,
      "InstanceId" : "1111",
      "AcuUsed" : 1,
      "Algorithms" : [ {
        "AlgorithmName" : "人脸算法",
        "AlgorithmId" : "10000"
      } ]
    } ],
    "CurrentPage" : 1,
    "PageSize" : 10,
    "TotalCount" : 32
  },
  "Code" : "0",
  "Success" : true
}

错误码

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