Queries whether an ApsaraDB for Redis instance is authorized to use Key Management Service (KMS).
Operation description
- For information about Transparent Data Encryption (TDE) and the usage notes of TDE, see Enable TDE.
- If the ApsaraDB for Redis instance is authorized to use KMS, you can call the ModifyInstanceTDE operation to enable TDE.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| kvstore:CheckCloudResourceAuthorized | Read |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| InstanceId | string | Yes | The ID of the instance. You can call the DescribeInstances operation to query the ID of the instance. | r-bp1zxszhcgatnx**** |
| RoleArn | string | Yes | The Alibaba Cloud Resource Name (ARN) of the Resource Access Management (RAM) role that you want to attach to your ApsaraDB for Redis instance. The ARN must be in the format of Note
| acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole |
Response parameters
Examples
Sample success responses
JSONformat
{
"AuthorizationState": 1,
"RequestId": "A501A191-BD70-5E50-98A9-C2A486A82****"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||
|---|---|---|---|---|
| 2023-07-20 | API Description Update | see changesets | ||
|