GetIpcDeviceInfo

更新时间:
复制 MD 格式

Obtain IPC device information.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

DeviceId

string

No

Device ID.

d123

StartTime

string

No

Start Time. UTC time in the format yyyy-MM-ddTHH:mm:ssZ.

2017-01-11T12:00:00Z

EndTime

string

No

End Time. UTC time in the format yyyy-MM-ddTHH:mm:ssZ. The difference between EndTime and StartTime must not exceed 180 days.

2017-02-11T12:00:00Z

Capability

string

No

Capability. Default value is understand. Valid values:

  • understand: understanding

  • understand-reid: understanding with reid

  • search: search

understand

PageNo

integer

No

Page number for paging. Default value: 1.

1

PageSize

integer

No

Page size, which specifies the number of entries displayed per page. Default value is 10. Maximum value is 50.

10

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

Request ID.

******11-DB8D-4A9A-875B-275798******

DeviceInfos

array<object>

List of device identity information.

object

List of device identity information.

DeviceId

string

Device ID.

d123

Capability

string

Capability. Valid values:

  • understand: understanding

  • understand-reid: understanding with reid

  • search: search

understand

ExpireTime

string

Expiration Time. UTC time in the format yyyy-MM-ddTHH:mm:ssZ.

2017-02-11T12:00:00Z

Total

integer

Total number of records.

78

Examples

Success response

JSON format

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "DeviceInfos": [
    {
      "DeviceId": "d123",
      "Capability": "understand",
      "ExpireTime": "2017-02-11T12:00:00Z"
    }
  ],
  "Total": 78
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.