Obtaining Details About an Edge Resource Pool
Function
This API is used to obtain details about an edge resource pool.
URI
GET /v2/{project_id}/edge-pools/{id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details, see Obtaining a Project ID and Name. |
id |
Yes |
String |
ID of an edge resource pool |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. For details about how to obtain a user token, see Authentication. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
String |
Edge pool ID |
name |
String |
Name of an edge resource pool |
description |
String |
Description |
state |
String |
Edge pool status |
project_id |
String |
Project ID |
workspace_id |
String |
Workspace ID |
created_at |
Long |
Creation time |
updated_at |
Long |
Update time |
nodes |
Array of EdgeNodeInfoDto objects |
Edge node list |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Edge node ID |
name |
String |
Name of an edge resource pool |
description |
String |
Description. If the description is empty, this parameter is not returned. |
state |
String |
Edge pool status |
cpu |
Integer |
Number of CPU cores |
arch |
String |
Computer architecture |
enable_gpu |
Boolean |
Whether to use GPUs |
enable_npu |
Boolean |
Whether to use NPUs |
memory |
Integer |
Memory size |
gpu_info |
Array of GpuInfo objects |
GPU information |
npu_info |
Array of NpuInfo objects |
NPU information |
Parameter |
Type |
Description |
---|---|---|
name |
String |
GPU name |
driver_version |
String |
GPU driver version |
type |
String |
GPU type |
capacity |
String |
GPU capacity |
Parameter |
Type |
Description |
---|---|---|
name |
String |
NPU name |
driver_version |
String |
NPU driver version |
type |
String |
NPU type |
capacity |
String |
NPU capacity |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error description |
detail |
String |
Error details |
params |
Array of strings |
Error parameters Array Length: 0 - 1 |
reason |
String |
Error cause |
advice |
String |
Suggestion |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error description |
detail |
String |
Error details |
params |
Array of strings |
Error parameters Array Length: 0 - 1 |
reason |
String |
Error cause |
advice |
String |
Suggestion |
Example Requests
This request is used to obtain details about the edge resource pool whose ID is xxx.
GET https://{endpoint}/v2/{project_id}/edge-pools/xxx
Example Responses
Status code: 200
Response body for obtaining details about an edge resource pool
{ "id" : "xxx", "name" : "yundao2", "state" : "Running", "project_id" : "xxx", "workspace_id" : "0", "created_at" : 1683344661036, "updated_at" : 1683344661036, "nodes" : [ { "id" : "xxx", "name" : "Edge node 2 for testing", "state" : "Running", "cpu" : 16, "arch" : "x86_64", "enable_gpu" : true, "enable_npu" : false, "memory" : 64263, "gpu_info" : [ { "name" : "gp0", "driver_version" : "418.67", "type" : "Tnt004", "capacity" : "15079Mi" } ], "npu_info" : [ ] } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
Response body for obtaining details about an edge resource pool |
400 |
Request error |
500 |
Internal error |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot