Retrieves the details of one or more node packages.
Try it now
Test
RAM authorization
Request syntax
GET HTTP/1.1
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| PackageIds |
array |
No |
An array of package IDs. |
|
|
string |
No |
The package ID. |
cmag-0c1g77wjljl9hc**** |
|
| InstanceIds |
array |
No |
An array of node instance IDs. |
|
|
string |
No |
The node instance ID. |
acp-itoxpeisht7if**** |
|
| PackageSpec |
string |
No |
The package specification. |
advanced |
| PackageStatus |
string |
No |
The package status. |
ACTIVE |
| PageNum |
integer |
No |
The page number. Default value: 1. |
1 |
| PageSize |
integer |
No |
The number of entries per page. |
100 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The data returned. |
||
| RequestId |
string |
The request ID. |
1CBAFFAB-B697-4049-A9B1-67E1FC**** |
| Code |
string |
The status code. A value of 200 indicates that the request was successful. |
200 |
| Message |
string |
The response message. |
Success. |
| TotalCount |
string |
The total number of entries. |
30 |
| PackageList |
array<object> |
A list of packages. |
|
|
object |
The details of a package. |
||
| PackageId |
string |
The package ID. |
cmag-bp19i1yxu60r7twy**** |
| PackageStatus |
string |
The package status. |
ACTIVE |
| InstanceIds |
array |
The list of node instance IDs. |
|
|
string |
The node instance ID. |
acp-iuyb1zv1ap6nb**** |
|
| PackageCredit |
string |
The total package credit. |
8000 |
| UsedCredit |
string |
The amount of credit used. |
1000 |
| ExpiredAt |
string |
The expiration time. |
2026-10-30 00:00:00 |
| PackageSpec |
string |
The package specification. |
advanced |
| PackageSpecName |
string |
Examples
Success response
JSON format
{
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC****",
"Code": "200",
"Message": "Success.",
"TotalCount": "30",
"PackageList": [
{
"PackageId": "cmag-bp19i1yxu60r7twy****",
"PackageStatus": "ACTIVE",
"InstanceIds": [
"acp-iuyb1zv1ap6nb****"
],
"PackageCredit": "8000",
"UsedCredit": "1000",
"ExpiredAt": "2026-10-30 00:00:00 ",
"PackageSpec": "advanced",
"PackageSpecName": ""
}
]
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.