Lists the KMS instances.
Operation description
For more information about the access policy required for a RAM user or RAM role to call this operation, see Resource Access Management.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| PageNumber |
integer |
No |
The number of the page to return. The default value is 1. |
1 |
| PageSize |
integer |
No |
The number of entries to return on each page. Valid values: 1 to 100. Default value: 20. |
10 |
Response parameters
|
Parameter |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The ID of the request. |
d3eca5c8-a856-4347-8eb6-e1898c3fda2e |
| KmsInstances |
object |
||
| KmsInstance |
array<object> |
A list of KMS instances. |
|
|
object |
A list of KMS instances. |
||
| KmsInstanceArn |
string |
The ARN of the KMS instance. |
acs:kms:pre-hangzhou:120708975881****:keystore/kst-phzz64c9f84eo32dbs**** |
| KmsInstanceId |
string |
The ID of the KMS instance. |
kst-phzz64c9f84eo32dbs**** |
| TotalCount |
integer |
The total number of KMS instances. |
1 |
| PageNumber |
integer |
The page number of the returned page. |
1 |
| PageSize |
integer |
The number of KMS instances returned per page. |
10 |
Examples
Success response
JSON format
{
"RequestId": "d3eca5c8-a856-4347-8eb6-e1898c3fda2e",
"KmsInstances": {
"KmsInstance": [
{
"KmsInstanceArn": "acs:kms:pre-hangzhou:120708975881****:keystore/kst-phzz64c9f84eo32dbs****",
"KmsInstanceId": "kst-phzz64c9f84eo32dbs****"
}
]
},
"TotalCount": 1,
"PageNumber": 1,
"PageSize": 10
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | IllegalTimestamp | The input parameter Timestamp that is mandatory for processing this request is not supplied. | The input parameter timestamp indicates that the request is outside the processing time range. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.