CheckKMSAuthorized - PolarDB - Centro de documentación de Alibaba Cloud

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

polardb:CheckKMSAuthorized

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	No	El ID de la región. Nota Llame a la operación DescribeRegions para consultar información sobre las regiones disponibles de la cuenta de destino, incluidos los ID de región.	cn-hangzhou
DBClusterId	string	Sí	El ID del clúster. Nota Llame a la operación DescribeDBClusters para consultar información sobre todos los clústeres en la región de destino, incluidos los ID de clúster.	pc-************
TDERegion	string	No	La región donde se encuentra la clave de cifrado transparente de datos (TDE).	cn-beijing

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
AuthorizationState	integer	El estado de autorización. Valores válidos: 0: No autorizado. 1: Autorizado.	0
RequestId	string	El ID de la solicitud.	A7E6A8FD-C50B-46B2-BA85-D8B8D3******
RoleArn	string	El descriptor global de recursos del rol. Especifica el rol. Para obtener más información, consulte Resumen de roles de RAM.	acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole
DBClusterId	string	El ID del clúster.	pc-************

Ejemplos

Respuesta exitosa

JSON Formato

{
  "AuthorizationState": 0,
  "RequestId": "A7E6A8FD-C50B-46B2-BA85-D8B8D3******",
  "RoleArn": "acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole",
  "DBClusterId": "pc-************"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
403	UnsupportedKmsService.NotEnabled	KMS service is not enabled.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.