Retrieves details for AI Real-Time Communication license batches that match specified filter criteria.
Operation description
Description
Retrieve AI Real-Time Communication license batches based on filter criteria such as License Item ID, Status, and Type.
The
NeedTotalCountparameter defaults totrue. When set to true, the response includes the total count of matching entries. To exclude the total count, set this parameter tofalse.If you do not specify any filter criteria, the operation returns the details for all license batches by default.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| LicenseItemId |
string |
No |
The License Item ID. |
17712*** |
| Status |
integer |
No |
The status of the license batch. Valid values:
|
1 |
| Type |
integer |
No |
The license type. Valid values:
|
1 |
| PageNo |
integer |
No |
The page number. |
1 |
| PageSize |
integer |
No |
The page size. |
10 |
| NeedTotalCount |
boolean |
No |
Specifies whether to return the total count. Default value: |
true |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The request ID. |
7B117AF5-2A16-412C-B127-FA6175ED1*** |
| Success |
boolean |
Indicates whether the request was successful. |
true |
| Code |
string |
The error code. |
Success |
| Message |
string |
The error message. |
OK |
| HttpStatusCode |
integer |
The HTTP status code. |
httpStatusCode |
| LicenseInfoList |
array |
The list of license batch details. |
|
| AiRtcLicenseInfoDTO |
The details of a license batch. |
||
| TotalCount |
integer |
The total count. |
100 |
Examples
Success response
JSON format
{
"RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1***",
"Success": true,
"Code": "Success",
"Message": "OK",
"HttpStatusCode": 0,
"LicenseInfoList": [
{
"CreationTime": "2020-12-23T13:33:49Z",
"ModificationTime": "2020-12-23T13:33:49Z",
"Type": 1,
"LicenseItemId": "17712***",
"Status": 1,
"ValidDays": 365,
"ExpiredOn": "2021-12-23T13:33:49Z",
"BeginOn": "2020-12-23T13:33:49Z",
"LicenseCount": 10000,
"AvailableCapacity": 10000000,
"InstanceId": "ice_CoverAILicense_public_cn***",
"ContractNo": "258396267390***"
}
],
"TotalCount": 100
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.