文档

DescribeDevice - 查询设备

更新时间:

查询设备信息。

调试

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

授权信息

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

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

请求参数

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

设备 ID。

3238848****092996-cn-qingdao
IncludeStatsboolean

是否返回流统计信息,默认值:false。

false
IncludeDirectoryboolean

是否返回目录信息,默认值:false。

false

返回参数

名称类型描述示例值
object
Typestring

设备类型。取值范围:

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

设备状态。取值范围:

  • on(在线)
  • off(离线)
  • failed(锁定)
  • new(未注册)
on
AlarmMethodstring

订阅的国标报警方式。取值范围:

  • 0(全部)
  • 5(视频报警)
  • 7(其他报警)
说明
  • 空值表示不订阅。
  • 支持多个,用英文逗号(,)分隔。
  • 5
    Dsnstring

    设备序列号。

    7D0*****4C0
    Portlong

    设备端口。

    8080
    PosIntervallong

    位置订阅周期,单位:秒。

    300
    ParentIdstring

    上级设备 ID,比如:摄像头所属的平台 ID。

    3238848****092995-cn-qingdao
    Passwordstring

    设备密码。

    admin
    AutoPosboolean

    是否启用设备位置订阅。

    false
    Paramsstring

    设备其他参数。

    {}
    RequestIdstring

    请求 ID。

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

    设备描述。

    xxx路口摄像头
    Enabledboolean

    设备是否启用。

    true
    Namestring

    设备名称。

    xxx路口摄像头
    ChannelSyncTimestring

    通道同步时间。

    2019-02-28T17:01:17Z
    CreatedTimestring

    设备创建时间。

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

    目录 ID。

    3238848****092994-cn-qingdao
    RegisteredTimestring

    设备注册时间。

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

    设备注册协议。

    gb28181
    Ipstring

    设备 IP。

    10.10.10.10
    Urlstring

    设备上的流 URL。

    rtmp://xxx/xxx
    AutoStartboolean

    是否自动启动流。

    false
    Vendorstring

    设备厂商。

    公司A
    GbIdstring

    设备国标 ID。

    说明 仅适用于国标协议。
    31000000****00000002
    GroupIdstring

    设备所属空间 ID。

    3238848****092994-cn-qingdao
    Longitudestring

    设备经度。

    45.00
    Latitudestring

    设备维度。

    119.20
    Idstring

    设备 ID。

    3238848****092996-cn-qingdao
    Usernamestring

    设备用户名。

    admin
    Statsobject

    设备流统计信息。

    FailedNumlong

    失败流数量。

    1
    StreamNumlong

    流数量。

    1
    ChannelNumlong

    通道数量。

    1
    OnlineNumlong

    在线流数量。

    1
    OfflineNumlong

    离线流数量。

    1
    Directoryobject

    目录信息。

    ParentIdstring

    上级目录 ID。

    3238848****092995-cn-qingdao
    Descriptionstring

    目录描述。

    目录1
    GroupIdstring

    目录所属空间 ID。

    3238848****092994-cn-qingdao
    Namestring

    目录名称。

    目录1
    CreatedTimestring

    目录创建时间。

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

    目录 ID。

    3238848****092994-cn-qingdao

    示例

    正常返回示例

    JSON格式

    {
      "Type": "ipc",
      "Status": "on",
      "AlarmMethod": "5",
      "Dsn": "7D0*****4C0",
      "Port": 8080,
      "PosInterval": 300,
      "AutoDirectory": true,
      "ParentId": "3238848****092995-cn-qingdao",
      "Password": "admin",
      "AutoPos": false,
      "Params": "{}",
      "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
      "Description": "xxx路口摄像头",
      "Enabled": true,
      "Name": "xxx路口摄像头",
      "ChannelSyncTime": "2019-02-28T17:01:17Z",
      "CreatedTime": "2019-02-28T17:00:17Z",
      "DirectoryId": "3238848****092994-cn-qingdao",
      "RegisteredTime": "2019-02-28T17:00:17Z",
      "Protocol": "gb28181",
      "Ip": "10.10.10.10",
      "Url": "rtmp://xxx/xxx",
      "AutoStart": false,
      "Vendor": "公司A",
      "GbId": "31000000****00000002",
      "GroupId": "3238848****092994-cn-qingdao",
      "Longitude": "45.00",
      "Latitude": "119.20",
      "Id": "3238848****092996-cn-qingdao",
      "Username": "admin",
      "Stats": {
        "FailedNum": 1,
        "StreamNum": 1,
        "ChannelNum": 1,
        "OnlineNum": 1,
        "OfflineNum": 1
      },
      "Directory": {
        "ParentId": "3238848****092995-cn-qingdao",
        "Description": "目录1",
        "GroupId": "3238848****092994-cn-qingdao",
        "Name": "目录1",
        "CreatedTime": "2019-02-28T17:00:17Z",
        "Id": "3238848****092994-cn-qingdao"
      }
    }

    错误码

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