DescribeInstanceSSL - ApsaraDB for OceanBase (Deprecated) - Centro de documentación de Alibaba Cloud

Consulta los detalles de SSL de un clúster de OceanBase.

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

oceanbase:DescribeInstanceSSL

none

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
InstanceId	string	Sí	El ID del clúster de OceanBase.	ob317v4uif****
TenantId	string	No	El ID de inquilino de OceanBase.

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los datos devueltos.
RequestId	string	El ID de la solicitud.	EE205C00-30E4-xxxx-xxxx-87E3A8A2AA0C
InstanceSSL	object	Los detalles de SSL de la instancia.
InstanceId	string	El ID del clúster de OceanBase.	ob317v4uif****
EnableSSL	string	Indica si el cifrado de enlace SSL está habilitado.	OPEN
ValidPeriod	string	La hora de vencimiento.	2024-09-20 07:55:03.0
CaUrl	string	La URL del certificado de CA.	https://xxxx
Status	string	El estado de SSL.	RUNNING
ForceSSLSupport	boolean	Indica si se admite SSL forzado.	false
ForceSSL	string	El estado de SSL forzado.	CLOSE
AutoUpdate	string	Indica si las actualizaciones automáticas de certificados SSL están habilitadas. Valores válidos: CLOSE : La actualización automática está deshabilitada. OPEN : La actualización automática está habilitada.	OPEN
TenantId	string	El ID de inquilino de OceanBase.
CertValid	boolean	Indica si el certificado es válido actualmente.

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "EE205C00-30E4-xxxx-xxxx-87E3A8A2AA0C",
  "InstanceSSL": {
    "InstanceId": "ob317v4uif****",
    "EnableSSL": "OPEN",
    "ValidPeriod": "2024-09-20 07:55:03.0",
    "CaUrl": "https://xxxx",
    "Status": "RUNNING",
    "ForceSSLSupport": false,
    "ForceSSL": "CLOSE",
    "AutoUpdate": "OPEN",
    "TenantId": "",
    "CertValid": false
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
500	InternalError	The request processing has failed due to some unknown error.

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.