DescribePurchasedDevices - 查询已购买设备列表

查询已购买设备列表。

调试

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

授权信息

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

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

请求参数

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

按设备 ID 查询。

4070*****1132-cn-qingdao
Namestring

按设备名称查询。

xxx路口摄像头
Typestring

按设备类型查询。取值:

  • ipc(摄像头)
  • platform(平台)
  • ied(智能设备)
ipc
SubTypestring

按设备子类型查询。取值:

  • bullet(枪机)
  • dome(球机)
  • ptz(PTZ)
dome
GroupIdstring

按设备所属空间 ID 查询。

348*****174-cn-qingdao
Vendorstring

按设备厂商查询。

公司A
SortBystring

按给定字段排序。取值:

  • id(默认)
id
SortDirectionstring

排序方式,默认升序。取值:

  • asc(升序)
  • desc(降序)
asc
PageSizelong

分页大小,默认为 20。

20
PageNumlong

第几个分页,默认为 1。

1

返回参数

名称类型描述示例值
object
PageNumlong

第几个分页。

1
PageSizelong

分页大小。

20
RequestIdstring

请求 ID。

BEA5625F-8FCF-48F4-851B-CA63946DA664
TotalCountlong

设备总数。

1
PageCountlong

分页总数。

1
Devicesarray<object>

设备列表。

Deviceobject
Typestring

按设备类型查询。取值:

  • ipc(摄像头)
  • platform(平台)
  • ied(智能设备)
ipc
SubTypestring

按设备子类型查询。取值:

  • bullet(枪机)
  • dome(球机)
  • ptz(PTZ)
dome
Vendorstring

设备厂商。

公司A
Descriptionstring

设备描述。

xxx路口摄像头
RegisterCodestring

设备注册码。

1234*****67890
GroupIdstring

设备所属空间 ID。

348*****174-cn-qingdao
GroupNamestring

空间名称。

测试空间
Regionstring

空间所属区域,即服务中心。

cn-qingdao
Namestring

设备名称。

xxx路口摄像头
CreatedTimestring

设备创建时间。

2019-02-28T17:00:17Z
Idstring

设备 ID。

348*****380-cn-qingdao
OrderIdstring

订单 ID。

2117*****0447

示例

正常返回示例

JSON格式

{
  "PageNum": 1,
  "PageSize": 20,
  "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
  "TotalCount": 1,
  "PageCount": 1,
  "Devices": [
    {
      "Type": "ipc",
      "SubType": "dome",
      "Vendor": "公司A",
      "Description": "xxx路口摄像头",
      "RegisterCode": "1234*****67890",
      "GroupId": "348*****174-cn-qingdao",
      "GroupName": "测试空间",
      "Region": "cn-qingdao",
      "Name": "xxx路口摄像头",
      "CreatedTime": "2019-02-28T17:00:17Z",
      "Id": "348*****380-cn-qingdao",
      "OrderId": "2117*****0447"
    }
  ]
}

错误码

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