All Products
Search
Document Center

Cloud Phone:DescribeKeyPairs

Last Updated:Jan 29, 2026

Queries one or more key pairs.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

KeyPairIds

array

No

The IDs of the ADB key pairs.

string

No

The ID of the ADB key pair.

kp-6v2q33ae4tw3*****

KeyPairName

string

No

The name of the ADB key pair.

testKeyPairName

MaxResults

integer

No

The maximum number of entries per page. Valid values: 1 to 100. Default value: 10.

10

NextToken

string

No

The pagination token that is used in the next request to retrieve a new page of results. If the parameter is left empty, the data is queried from the first entry.

AAAAAYRHtOLVQzCYj17y+OP7LZQBUVVbi0GTu8g5****

Response elements

Element

Type

Description

Example

object

The response parameters.

NextToken

string

A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.

FFbc8N4E1iOlcSxC+8boa0HHH2LKWbggYUinyrZWvtS1oTrMYCg1HuMLGuftj0****

Data

array<object>

The objects that are returned.

object

The object that is returned.

KeyPairId

string

The ID of the ADB key pair.

kp-6v2q33ae4tw3a****

KeyPairName

string

The name of the ADB key pair.

testKeyPairName

GmtCreated

string

The time when the ADB key pair was created.

2022-10-11T08:53:32Z

TotalCount

integer

The total number of entries returned.

10

RequestId

string

The ID of the request.

565FB06A-AE04-5AD0-8A32-5BA92CA5****

Examples

Success response

JSON format

{
  "NextToken": "FFbc8N4E1iOlcSxC+8boa0HHH2LKWbggYUinyrZWvtS1oTrMYCg1HuMLGuftj0****",
  "Data": [
    {
      "KeyPairId": "kp-6v2q33ae4tw3a****",
      "KeyPairName": "testKeyPairName",
      "GmtCreated": "2022-10-11T08:53:32Z"
    }
  ],
  "TotalCount": 10,
  "RequestId": "565FB06A-AE04-5AD0-8A32-5BA92CA5****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.