DescribeKeyPairs - Cloud Phone - Alibaba Cloud Documentation Center

Queries one or more key pairs.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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 parameters

Parameter	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.
data	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

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.