GetProxy - Data Management - Centro de documentación de Alibaba Cloud

Consulta los detalles de un proxy de acceso seguro.

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

dms:GetProxy

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ProxyId	integer	Sí	El ID del proxy de acceso seguro. Puede llamar a la operación ListProxies para consultar el ID del proxy de acceso seguro.	4**
Tid	integer	No	El ID del inquilino. Puede llamar a la operación GetUserActiveTenant para obtener el ID del inquilino.	3***

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
RequestId	string	El ID de la solicitud.	F49D4598-2B3C-5723-865E-2CCB818E****
Success	boolean	Indica si la solicitud se realizó correctamente. Valores válidos: true: La solicitud se realizó correctamente. false: La solicitud falló.	true
ErrorMessage	string	El mensaje de error devuelto si la solicitud falló.	The condition cannot be empty!
ErrorCode	string	El código de error devuelto si la solicitud falló.	UnknownError
ProxyId	integer	El ID del proxy de acceso seguro.	4**
CreatorId	integer	El ID del usuario que habilitó la función de proxy de acceso seguro.	12****
CreatorName	string	El apodo del usuario que habilitó la función de proxy de acceso seguro.	test_name
InstanceId	integer	El ID de la instancia.	183****
PrivateEnable	boolean	Indica si el endpoint interno estaba habilitado. Valor predeterminado: true.	true
PrivateHost	string	El endpoint interno.	dphzmy-5j8oimjsz6ze****.proxy.dms.aliyuncs.com
PublicEnable	boolean	Indica si el endpoint público estaba habilitado. Valores válidos: true: El endpoint público estaba habilitado. false: El endpoint público estaba deshabilitado.	true
PublicHost	string	El endpoint público. Se devuelve un endpoint público independientemente de si el endpoint público está habilitado o deshabilitado. Nota Si el valor del parámetro PublicEnable es true, se devuelve un endpoint público válido que se puede resolver mediante Alibaba Cloud DNS. Si el valor del parámetro PublicEnable es false, se devuelve un endpoint público no válido que no se puede resolver mediante Alibaba Cloud DNS.	dphzmy-5j8oimjsz6zed7k****.proxy.dms.aliyuncs.com
HttpsPort	integer	El número de puerto utilizado por el protocolo HTTPS.	443
ProtocolType	string	El tipo de protocolo de la base de datos. Ejemplo: MYSQL.	MYSQL
ProtocolPort	integer	El número de puerto utilizado por el protocolo.	3306
RegionId	string	El ID de la región en la que reside la instancia.	cn-hangzhou

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "F49D4598-2B3C-5723-865E-2CCB818E****",
  "Success": true,
  "ErrorMessage": "The condition cannot be empty!",
  "ErrorCode": "UnknownError",
  "ProxyId": 0,
  "CreatorId": 0,
  "CreatorName": "test_name",
  "InstanceId": 0,
  "PrivateEnable": true,
  "PrivateHost": "dphzmy-5j8oimjsz6ze****.proxy.dms.aliyuncs.com",
  "PublicEnable": true,
  "PublicHost": "dphzmy-5j8oimjsz6zed7k****.proxy.dms.aliyuncs.com",
  "HttpsPort": 443,
  "ProtocolType": "MYSQL",
  "ProtocolPort": 3306,
  "RegionId": "cn-hangzhou"
}

Códigos de 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.