CheckCloudResourceAuthorized - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Checks whether Key Management Service (KMS) keys are authorized to an ApsaraDB for MongoDB instance.

Operation description

Before you enable Transparent Data Encryption (TDE) by calling the ModifyDBInstanceTDE operation, you can call this operation to check whether KMS keys are authorized to ApsaraDB for MongoDB instances.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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 Resources is 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
dds:CheckCloudResourceAuthorized	get	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The ID of the instance.	dds-bp18f7d6b6a7****
TargetRegionId	string	Yes	The region ID of the instance. You can call the DescribeDBInstanceAttribute operation to query the region ID of the instance.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object
AuthorizationState	integer	Indicates whether KMS keys are authorized to ApsaraDB for MongoDB instances. Valid values: 0: KMS keys are not authorized. 1: KMS keys are authorized. 2: KMS is not enabled.	1
RequestId	string	The ID of the request.	A0181AC4-F186-46ED-87CA-100C70B86729
RoleArn	string	The role information of the authorized Alibaba Resource Name (ARN). Note This parameter is returned only when the value of the AuthorizationState parameter is 1.	acs:ram::140****:role/aliyunrdsinstanceencryptiondefaultrole

Examples

Sample success responses

JSONformat

{
  "AuthorizationState": 1,
  "RequestId": "A0181AC4-F186-46ED-87CA-100C70B86729",
  "RoleArn": "acs:ram::140****:role/aliyunrdsinstanceencryptiondefaultrole"
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history