AllocateInstancePublicConnection - Tair (Redis® OSS-Compatible) - Centro de documentación de Alibaba Cloud

Descripción de la operación

También puede solicitar endpoints públicos en la consola de ApsaraDB for Redis. Para obtener más información, consulte Usar un endpoint público para conectarse a una instancia de ApsaraDB for Redis.

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

kvstore:AllocateInstancePublicConnection

create

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
InstanceId	string	Sí	El ID de la instancia.	r-bp1zxszhcgatnx****
ConnectionStringPrefix	string	Sí	El prefijo del endpoint público. El prefijo debe comenzar con una letra minúscula y puede contener letras minúsculas y dígitos. El prefijo puede tener entre 8 y 40 caracteres de longitud. Nota El endpoint tiene el formato `<prefijo>.redis.rds.aliyuncs.com`.	r-bp1zxszhcgatnx****
Port	string	Sí	El número de puerto de servicio de la instancia. Valores válidos: 1024 a 65535.	6379

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	20C8341E-B5AD-4B24-BD82-D73241522ABF

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "20C8341E-B5AD-4B24-BD82-D73241522ABF"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	MissingInstanceId	InstanceId is mandatory for this action.
400	MissingConnectionString	ConnectionStringPrefix is mandatory for this action.
400	MissingPort	Port is mandatory for this action.
400	NetTypeExists	Specified net type already existed.	The specified network type already exists
400	InvalidConnectionString.Format	Specified connection string is not valid.	The connection string is invalid. Use a different one.
400	NewSSLAlreadyEnabled	new SSL have already been enabled.	The instance has the new SSL certificate enabled.
403	SSLNotSupportNetType	SSL instance does not support create public network.	SSL-enabled instances do not allow you to create public networks.

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.