cvm · 2017-03-12

DescribeKeyPairs

POST

Query key pairs.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cvm/DescribeKeyPairs 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: DescribeKeyPairs' \
  -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
KeyIds	string[]	—	Key pair ID(s) in the format of `skey-11112222`. This API supports using multiple IDs as filters at the same time. For more information on the format of this parameter, see the `id.N` section in API Introduction. You cannot specify `KeyIds` and `Filters` at the same time. You can log in to the console to query the key pair IDs.
Filters	Filter[]	—	Filters
Offset	integer	—	Offset. The default value is `0`. For more information on `Offset`, see the relevant section in API Introduction.
Limit	integer	—	Number of results returned; default value: 20; maximum: 100. For more information on `Limit`, see the corresponding section in API Introduction.

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
TotalCount	integer	Number of key pairs meeting the filtering conditions.
KeyPairSet	KeyPair[]	Detailed information on key pairs.
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": {
    "TotalCount": …,
    "KeyPairSet": …,
    "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 · DescribeKeyPairs

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

Read-only. Creates nothing.

Recorded example response — captured 2026-09-16

{
  "Response": {
    "TotalCount": 1,
    "KeyPairSet": [
      {
        "KeyId": "skey-mcwiow7k",
        "KeyName": "example_key",
        "Description": "",
        "PublicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDKqAxreoL9jsQdy4pBp/gXUeRUKPVQPNNuDfLeoGxDT37cxYp71wlZjww+zmC61aDYjUlVGg8RfK3i+AS6G7p00eJsJAwAThVZHJUOVw1TDMG95Rf9W6kqxCaUGw7t3x65ZOVobVYEGMGzjCI3/a0F+M1L3f0ZT+W1hEi8KIIBOFhXy/zzUgZaIDmF+Xx0xVDa/8sdKlNtcrXhjjiIoxY+26LxFwqI1lP3QMe0eh4x1QH81Mt69OHY62nsPRi13bPIyQzsR6O9CYROgshoZ8a/BF8K1t+BM8kYdDSAnEitM4icTey30ayqDDYx1vrMVgaeV4G50qe4Y6ClQOc1/sKb skey-mcwiow7k",
        "AssociatedInstanceIds": [],
        "AssociatedInstanceCount": 0,
        "AssociatedImageCount": 0,
        "ProjectId": 0,
        "CreatedTime": "2026-09-16T11:38:51Z",
        "Tags": []
      }
    ],
    "RequestId": "0e5b5c23-8370-af54-36da-f2d6934980b6"
  }
}

Behaviour

Does not return private key material. Key pair ids are prefixed skey-.