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

Consulta los endpoints de base de datos.

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

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DBClusterId}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
DBClusterId	string	Sí	El ID del clúster.	pc-****************
ConnectionStringType	string	No	El tipo de endpoint. Valores válidos: Normal: el endpoint principal ReadWriteSplitting: el endpoint del clúster MPP: el endpoint de procesamiento masivamente paralelo (MPP)	Normal

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La información sobre el endpoint del clúster.
DBClusterNetInfos	object
DBClusterNetInfo	array<object>	La información sobre el endpoint del clúster.
	object	La información sobre el endpoint del clúster.
VSwitchId	string	El ID del vSwitch.	vsw-bp1li3eavsz8oaexq15dw
ConnectionStringType	string	El tipo de endpoint. Valores válidos: Normal: el endpoint principal ReadWriteSplitting: el endpoint del clúster MPP: el endpoint MPP	MPP
ConnectionString	string	El endpoint de la base de datos.	pc-****************.pg.polardb.pre.rds.aliyuncs.com
IPType	string	El tipo de red de la dirección IP. Valores válidos: Public: Internet. Inner: la red clásica. Private: una nube privada virtual (VPC).	Public
Port	string	El número de puerto.	1521
VPCId	string	El ID de la VPC.	vpc-***************
IPAddress	string	La dirección IP.	121...173
ClusterNetworkType	string	El tipo de red del clúster. El valor es fijo: VPC.	VPC
RequestId	string	El ID de la solicitud.	72D99256-ACF1-5F86-831F-8CB53E9C23ED
DBNodeNetInfos	object
DBNodeNetInfo	array<object>	La información sobre el endpoint del nodo.
	array<object>	La información sobre el endpoint del nodo.
NetInfos	object
NetInfo	array<object>	La información sobre el endpoint del nodo.
	object	La información sobre el endpoint del nodo.
VSwitchId	string	El ID del vSwitch.	vsw-*************
ConnectionString	string	El endpoint de la base de datos.	pc-****************.pg.polardb.pre.rds.aliyuncs.com
IPType	string	El tipo de red de la dirección IP. Valores válidos: Public: Internet. Inner: la red clásica. Private: una VPC.	Public
Port	string	El número de puerto.	5432
VPCId	string	El ID de la VPC.	vpc-****************
IPAddress	string	La dirección IP.	47...203
DBNodeRole	string	El rol del nodo. Valores válidos: Writer: el nodo principal. Reader: un nodo de solo lectura. ColumnReader: un nodo de solo lectura de almacenamiento en columnas. AI: un nodo de IA.	Writer
DBInstanceId	string	El ID de la instancia.	pc-*************

Ejemplos

Respuesta exitosa

JSON Formato

{
  "DBClusterNetInfos": {
    "DBClusterNetInfo": [
      {
        "VSwitchId": "vsw-bp1li3eavsz8oaexq15dw",
        "ConnectionStringType": "MPP",
        "ConnectionString": "pc-****************.pg.polardb.pre.rds.aliyuncs.com",
        "IPType": "Public",
        "Port": "1521",
        "VPCId": "vpc-***************",
        "IPAddress": "121.*.*.173"
      }
    ]
  },
  "ClusterNetworkType": "VPC",
  "RequestId": "72D99256-ACF1-5F86-831F-8CB53E9C23ED",
  "DBNodeNetInfos": {
    "DBNodeNetInfo": [
      {
        "NetInfos": {
          "NetInfo": [
            {
              "VSwitchId": "vsw-*************",
              "ConnectionString": "pc-****************.pg.polardb.pre.rds.aliyuncs.com\n",
              "IPType": "Public",
              "Port": "5432",
              "VPCId": "vpc-****************",
              "IPAddress": "47.*.*.203"
            }
          ]
        },
        "DBNodeRole": "Writer",
        "DBInstanceId": "pc-*************"
      }
    ]
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.

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.