All Products
Search

This Product

    Tair (Redis® OSS-Compatible):CheckCloudResourceAuthorized

    Document Center

    Tair (Redis® OSS-Compatible):CheckCloudResourceAuthorized

    最終更新日:Oct 30, 2024

    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

    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.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InstanceIdstringYes

    The ID of the instance. You can call the DescribeInstances operation to query the ID of the instance.

    		r-bp1zxszhcgatnx****
    RoleArnstringYes

    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 acs:ram::$accountID:role/$roleName. After the role is attached, your ApsaraDB for Redis instance can use KMS.

    Note

    • $accountID: the ID of the Alibaba Cloud account. To view the account ID, log on to the Alibaba Cloud console, move the pointer over your profile picture in the upper-right corner of the page, and then click Security Settings.

    • $roleName: the name of the RAM role. Replace $roleName with AliyunRdsInstanceEncryptionDefaultRole.

    		acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole

    Response parameters

    ParameterTypeDescriptionExample
    object
    AuthorizationStateinteger

    Indicates whether the instance is authorized to use KMS. Valid values:

    • 0: The instance is authorized to use KMS.
    • 1: The instance is not authorized to use KMS.
    • 2: KMS is not activated. For more information, see Activate KMS.
    		1
    RequestIdstring

    The ID of the request.

    		A501A191-BD70-5E50-98A9-C2A486A82****

    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 timeSummary of changesOperation
    2023-07-20API Description UpdateView Change Details