Querying Lite Server Image Details
Function
This API is used to obtain the details of a specified Lite Server image. It is used when you need to know the configuration and attributes of a Lite Server image so that you can select a proper image when creating or adjusting a Lite Server instance. Before using this API, ensure that you have logged in to the system and have the permission to query image details, and the specified image exists. After the query, the API returns the details of the specified Lite Server image, including the image ID, name, OS, version, and creation time. If you do not have the operation permission, the specified image does not exist, or the image ID is invalid, the API returns an error message.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.
URI
GET /v1/{project_id}/dev-servers/images/{id}
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
id |
Yes |
String |
Definition: Image ID. Constraints: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ Range: N/A Default Value: N/A |
|
project_id |
Yes |
String |
Definition: Project ID. For details, see Obtaining a Project ID and Name. Constraints: The value can contain 1 to 64 characters. Letters, digits, and hyphens (-) are allowed. Range: N/A Default Value: N/A |
Request Parameters
None
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
arch |
String |
Definition: Architecture type of a server image. Range: |
|
image_id |
String |
Definition: Server image ID. Range: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ |
|
name |
String |
Definition: Server image name. Constraints: N/A Range: 1 to 256 characters Default Value: N/A |
|
server_type |
String |
Definition: Server type. Range: |
|
status |
String |
Definition: Server image status. Range: |
Example Requests
GET https://{endpoint}/v1/{project_id}/dev-servers/images/{id}
Example Responses
None
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Definition: Image details. |
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