You can call this operation to query the details of desktop templates.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer automatically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeBundles

The operation that you want to perform. Set the value to DescribeBundles.

RegionId String Yes cn-hangzhou

The ID of the region.

MaxResults Integer No 10

The number of entries to return on each page.

Valid values: 1 to 100.

Default value: 10.

NextToken String No caeba0bbb2be03f84eb48b699f0a4883

The token used to start the next query. If the value of this parameter is empty, all results are returned.

BundleId.N RepeatList No b-cezrnfgecbich****

The ID of desktop template N. You can specify one or more desktop template IDs. Valid values of N: 1 to 100.

BundleType String No SYSTEM

The type of the desktop template. Valid values:

  • SYSTEM: system template
  • CUSTOM: custom template

Response parameters

Parameter Type Example Description
Bundles Array of Bundle

Details of the desktop templates.

BundleId String b-cezrnfgecbich****

The ID of the desktop template.

BundleName String testBundleName

The name of the desktop template.

BundleType String SYSTEM

The type of the desktop template. Valid values:

  • SYSTEM: system template
  • CUSTOM: custom template
Description String This is description.

The description of the desktop template.

DesktopType String ecd.basic.large

The desktop specification.

Disks Array of Disk

Details of the disks.

DiskSize Integer 20480

The size of the disk. Unit: MiB.

DiskType String SYSTEM

The type of the disk. Valid values:

  • SYSTEM: system disk
  • DATA: data disk
ImageId String m-4zfb6zj728hhr****

The ID of the image.

NextToken String caeba0bbb2be03f84eb48b699f0a4883

The token used to start the next query. If the value of this parameter is empty, all results are returned.

RequestId String 4EE47BC4-5C63-4D2D-AEB5-AB2FC8867C68

The ID of the request.

Examples

Sample requests

https://ecd.cn-hangzhou.aliyuncs.com/?Action=DescribeBundles
&MaxResults=10
&BundleId.1=b-cezrnfgecbich****
&<Common request parameters>

Sample success responses

XML format

<DescribeBundlesResponse>
      <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
      <RequestId>4EE47BC4-5C63-4D2D-AEB5-AB2FC8867C68</RequestId>
      <Bundles>
            <BundleId>b-cezrnfgecbich****</BundleId>
            <Description>This is description. </Description>
            <BundleType>SYSTEM</BundleType>
            <DesktopType>ecd.basic.large</DesktopType>
            <ImageId>m-4zfb6zj728hhr****</ImageId>
            <BundleName>testBundleName</BundleName>
            <Disks>
                  <DiskType>SYSTEM</DiskType>
                  <DiskSize>20480</DiskSize>
            </Disks>
      </Bundles>
</DescribeBundlesResponse>

JSON format

{
    "NextToken":"caeba0bbb2be03f84eb48b699f0a4883",
    "RequestId":"4EE47BC4-5C63-4D2D-AEB5-AB2FC8867C68",
    "Bundles":[
        {
            "BundleId":"b-cezrnfgecbich****",
            "Description":"This is description.",
            "BundleType":"SYSTEM",
            "DesktopType":"ecd.basic.large",
            "ImageId":"m-4zfb6zj728hhr****",
            "BundleName":"testBundleName",
            "Disks":[
                {
                    "DiskType":"SYSTEM",
                    "DiskSize":20480
                }
            ]
        }
    ]
}

Error codes

For a list of error codes, visit the API Error Center.