Queries the information about images.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
ecd:DescribeImages | LIST |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The region ID. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
MaxResults | integer | No | The maximum number of entries to return on each page.
| 10 |
NextToken | string | No | The token that determines the start point of the next query. If you do not specify this parameter, all results are returned. | caeba0bbb2be03f84eb48b699f0a4883 |
ImageType | string | No | The type of the image. | SYSTEM |
ImageStatus | string | No | The state of the image. | Available |
GpuCategory | boolean | No | Specifies whether the images are GPU-accelerated images. Valid values:
| false |
ProtocolType | string | No | The protocol type. Valid values:
| ASP |
LanguageType | string | No | The language of the OS. | en-US |
DesktopInstanceType | string | No | The instance type of the cloud computer. You can call the DescribeDesktopTypes operation to obtain the parameter value. | ecd.graphics.xlarge |
ImageId | array | No | The IDs of the images. You can specify one or more image IDs. | |
string | No | The ID of the image. | m-gx2x1dhsmusr2**** | |
OsType | string | No | The type of the operating system of the images. Default value: Valid values:
| Windows |
GpuDriverVersion | string | No | The version of the GPU driver. | 417.22 |
SessionType | string | No | The session type. | SINGLE_SESSION |
FotaVersion | string | No | The image version. | 0.0.3-R-20220616.133609 |
ImageName | string | No | The image name. | Win_01 |
Response parameters
Examples
Sample success responses
JSON
format
{
"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
"RequestId": "4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB",
"Images": [
{
"CreationTime": "2018-01-10T01:01:10Z",
"Status": "Available",
"Progress": "100%",
"DataDiskSize": 150,
"ImageType": "SYSTEM",
"Description": "This is description.",
"Size": 40,
"OsType": "WINDOWS",
"ProtocolType": "ASP",
"Name": "testImageName",
"ImageId": "m-gx2x1dhsmusr2****",
"GpuCategory": false,
"SupportedLanguages": [
"en-US"
],
"GpuDriverVersion": "417.22",
"AppVersion": "1.0.0",
"VolumeEncryptionEnabled": false,
"VolumeEncryptionKey": "08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****",
"SharedCount": 1,
"SessionType": "MULTIPLE_SESSION",
"UpdateTime": "2021-12-22T02:48:43Z",
"Platform": "Windows Server 2019"
}
]
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2023-06-13 | The request parameters of the API has changed | see changesets | ||||||||
| ||||||||||
2021-10-28 | The request parameters of the API has changed. The response structure of the API has changed | see changesets | ||||||||
| ||||||||||
2021-10-28 | The response structure of the API has changed | see changesets | ||||||||
|