All Products
Search
Document Center

Intelligent Media Services:GetIpcDeviceInfo - Retrieves IPC device information

Last Updated:Dec 26, 2025

Retrieves information about an IPC device.

Debug

You can call this operation directly in OpenAPI Explorer to avoid calculating signatures. After a successful call, OpenAPI Explorer automatically generates SDK sample code.

Authorization information

The following table describes the authorization information for this operation. You can add this information to the Action element of a Resource Access Management (RAM) access policy to grant a RAM user or RAM role the permission to call this operation. The following list describes the columns in the table.

  • Operation: The specific permission.
  • Access level: The access level of each operation. Valid values are Write, Read, and List.
  • Resource type: The type of resource on which the operation can be authorized.
    • An asterisk (*) indicates a required resource type.
    • If an operation does not support resource-level authorization, this column is set to All resources.
  • Condition key: The condition keys defined by the cloud product.
  • Associated operation: Other permissions required to call the operation. The caller must also have permissions for the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ice:GetIpcDeviceInfoget
*All resources
*
    None
None

Request parameters

NameTypeRequiredDescriptionExample
DeviceIdstringNo

The device ID.

d123
StartTimestringNo

The start time. The time is in UTC. The format is yyyy-MM-ddTHH:mm:ssZ.

2017-01-11T12:00:00Z
EndTimestringNo

The end time. The time is in UTC. The format is yyyy-MM-ddTHH:mm:ssZ. The interval between the start time and the end time cannot exceed 180 days.

2017-02-11T12:00:00Z
CapabilitystringNo

The capability. Default value: understand. Valid values:

  • understand: The understanding capability.
  • understand-reid: The understanding capability that includes re-identification (re-ID).
  • search: The search capability.
understand
PageNointegerNo

The page number for paging. The default value is 1.

1
PageSizeintegerNo

The number of entries to return on each page. The default value is 10. The maximum value is 50.

10

Response parameters

NameTypeDescriptionExample
object

The response schema.

RequestIdstring

The request ID.

******11-DB8D-4A9A-875B-275798******
DeviceInfosarray<object>

A list of device information.

DeviceInfoobject

The device information.

DeviceIdstring

The device ID.

d123
Capabilitystring

The capability. Valid values:

  • understand: The understanding capability.
  • understand-reid: The understanding capability that includes re-identification (re-ID).
  • search: The search capability.
understand
ExpireTimestring

The expiration time. The time is in UTC. The format is yyyy-MM-ddTHH:mm:ssZ.

2017-02-11T12:00:00Z
Totallong

The total number of records.

78

Examples

Example of a successful response

JSON format

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

Error codes

For a list of error codes, see the Error Center.

Change history

Change dateChange SummaryOperation
2025-12-23Added this OpenAPI operation.View details