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

Consulta un canal de red.

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:DescribeNetworkChannel

get

*DBCluster.

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ResourceGroupId	string	No	El ID del grupo de recursos.	rg-************
DBClusterId	string	Sí	El nombre de la instancia de origen.	pc-*************
ChannelName	string	No	El nombre del canal.	ch4
VpcId	string	No	El ID de la VPC donde reside el endpoint de acceso.	vpc-bp1qpo0kug3a20qqe****
RegionId	string	No	El ID de la región.	cn-hangzhou
ClientToken	string	No	El token de cliente que se usa para garantizar la idempotencia de la solicitud. El cliente genera el token y garantiza que sea único entre solicitudes. El token distingue mayúsculas y minúsculas y puede contener hasta 64 caracteres ASCII.	6000170000591aed949d0f54a343f1a4233c1e7d1c5******

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de respuesta.
ChannelInfos	array<object>	La lista de canales de red.
	object	Los datos del canal de red.
ChannelName	string	El nombre del canal.	ch4
DBClusterId	string	El nombre de la instancia de origen.	pc-*************
EniId	string	El ID de las interfaces de red elásticas (ENI) utilizadas por el enlace de acceso inverso del canal de red. El controlador de interfaz de red (NIC) se usa para la conexión.	eni-2z******
Notes	string	Las observaciones.	actualización de prueba
RegionId	string	El ID de la región.	cn-hangzhou
TargetDBClusterId	string	El nombre de la instancia de destino.	pc-*************
TargetIp	string	La dirección IP de la instancia de destino.	33...240
TargetPort	string	El puerto de la instancia de destino.	3389
TargetType	string	El tipo de instancia de destino.	polardb_for_postgresql
VpcId	string	El ID de la VPC donde reside el endpoint de acceso.	vpc-2ze13g2c6j7j2jl*******
RequestId	string	El ID de la solicitud.	925B84D9-CA72-432C-95CF-738C22******

Ejemplos

Respuesta exitosa

JSON Formato

{
  "ChannelInfos": [
    {
      "ChannelName": "ch4",
      "DBClusterId": "pc-*************\n",
      "EniId": "eni-2z******",
      "Notes": "test update",
      "RegionId": "cn-hangzhou",
      "TargetDBClusterId": "pc-*************\n",
      "TargetIp": "33.*.*.240",
      "TargetPort": "3389",
      "TargetType": "polardb_for_postgresql",
      "VpcId": "vpc-2ze13g2c6j7j2jl*******"
    }
  ],
  "RequestId": "925B84D9-CA72-432C-95CF-738C22******"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	El DBClusterId especificado no existe en los registros actuales.

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.