cvm · 2017-03-12

DescribeImages

POST

View the list of images.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cvm/DescribeImages path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.

curl

curl -sS https://cvm.api3.convergecloud.com/ \
  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Host: cvm.api3.convergecloud.com' \
  -H 'X-TC-Action: DescribeImages' \
  -H 'X-TC-Version: 2017-03-12' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{"Offset":0,"Limit":20}'

Request parameters

Field	Type	Required	Description
ImageIds	string[]	—	List of image IDs, such as `img-gvbnzy6f`. For the format of array-type parameters, see API Introduction. You can obtain the image IDs in two ways: Call DescribeImages and look for `ImageId` in the response. View the image IDs in the Image Console.
Filters	Filter[]	—	Filters. Each request can have up to 10 `Filters`, and 5 `Filters.Values` for each filter. `ImageIds` and `Filters` cannot be specified at the same time. See details:
Offset	integer	—	Offset; default value: 0. For more information on `Offset`, see API Introduction.
Limit	integer	—	Number of results returned; default value: 20; maximum: 100. For more information on `Limit`, see API Introduction.
InstanceType	string	—	Instance type, e.g. `SA5.MEDIUM2`

Response

Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.

Field	Type	Description
ImageSet	Image[]	Information on an image, including its state and attributes.
TotalCount	integer	Number of images meeting the filtering conditions.
RequestId	string	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

Success

{
  "Response": {
    "ImageSet": …,
    "TotalCount": …,
    "RequestId": "…"
  }
}

Error

{
  "Response": {
    "Error": { "Code": "…", "Message": "…" },
    "RequestId": "…"
  }
}

Try it

CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/cvm.

SecretIdSecretKey

Request bodyvalid JSONPOST cvm.api3.convergecloud.com · DescribeImages

{
  "Offset": 0,
  "Limit": 20
}

Read-only. Creates nothing.

Behaviour

Records carry both IsSupportCloudinit and a lowercase isSupportCloudinit; a case-sensitive parser will match only one.