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

Consulta la lista de clústeres perimetrales de PolarDB.

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

list

*All resources.

*

Ninguna

Sintaxis de la solicitud

POST  HTTP/1.1

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
DBClusterId	string	Sí	El ID del clúster. Nota Nota: Solo se admiten los ID de clústeres perimetrales (clústeres creados al establecer el parámetro CloudProvider en ENS al llamar a CreateDBCluster). Si especifica el ID de clústeres comunes, se devuelve el error CrossCloudOpenAPI.CallError.	pc-***************
AccountName	string	No	El nombre de la cuenta.	test_acc
NodeType	string	No	El tipo de nodo. Este parámetro es obligatorio cuando se consultan las cuentas de los nodos de PolarDB Search. Valores válidos: Search	Search
PageNumber	integer	No	El número de página. Valores válidos: números enteros mayores que 0 y menores o iguales que el valor máximo del tipo Integer. Valor predeterminado: 1.	1
PageSize	integer	No	El número de entradas por página. Valores válidos: 30 50 100 Valor predeterminado: 30.	30
MaxResults	integer	No	El número máximo de entradas que se devolverán para esta solicitud.	10
NextToken	string	No	El token de consulta. Establezca el valor en el valor de NextToken devuelto en la última llamada a la API. Si no se requiere ninguna consulta posterior, no especifique este parámetro.	212db86sca4384811e0b5e8707e******

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
PageRecordCount	integer	El número de entradas en la página actual.	1
RequestId	string	El ID de la solicitud.	155462B9-205F-4FFC-BB43-4855FE******
PageNumber	integer	El número de página.	1
Accounts	array<object>	Los detalles de la información de la cuenta.
	array<object>	Los detalles de la información de la cuenta.
AccountDescription	string	La descripción de la cuenta.	test
AccountStatus	string	El estado de la cuenta. Valores válidos: Creating: La cuenta se está creando. Available: La cuenta está disponible. Deleting: La cuenta se está eliminando.	Available
AccountLockState	string	El estado de bloqueo de la cuenta. Valores válidos: UnLock: La cuenta no está bloqueada. Lock: La cuenta está bloqueada.	UnLock
AccountPasswordValidTime	string	La hora de vencimiento de la contraseña.	undefined
AccountType	string	El tipo de cuenta. Valores válidos: Normal: cuenta estándar. Super: cuenta con privilegios. ReadOnly: cuenta global de solo lectura.	Normal
DatabasePrivileges	array<object>	Los detalles de los permisos de base de datos otorgados a la cuenta.
	object	Los detalles de los permisos de base de datos otorgados a la cuenta.
AccountPrivilege	string	Los permisos de la cuenta.	ReadOnly
DBName	string	El nombre de la base de datos.	DBtest
AccountName	string	El nombre de la cuenta.	test_acc
NextToken	string	El token de consulta. Establezca el valor en el valor de NextToken devuelto en la última llamada a la API. Si no se requiere ninguna consulta posterior, no especifique este parámetro.	212db86sca4384811e0b5e8707e******
MaxResults	integer	El número máximo de entradas que se devolverán para esta solicitud.	10

Ejemplos

Respuesta exitosa

JSON Formato

{
  "PageRecordCount": 1,
  "RequestId": "155462B9-205F-4FFC-BB43-4855FE******",
  "PageNumber": 1,
  "Accounts": [
    {
      "AccountDescription": "test",
      "AccountStatus": "Available",
      "AccountLockState": "UnLock",
      "AccountPasswordValidTime": "undefined",
      "AccountType": "Normal",
      "DatabasePrivileges": [
        {
          "AccountPrivilege": "ReadOnly",
          "DBName": "DBtest"
        }
      ],
      "AccountName": "test_acc"
    }
  ],
  "NextToken": "212db86sca4384811e0b5e8707e******",
  "MaxResults": 10
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.	El parámetro PageSize especificado no es válido.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.	El parámetro PageNumber especificado no es válido.
400	Database.ConnectError	db instance %s connect failed, please check instance status and database processlist	La conexión a la base de datos falló. Verifique el estado de la instancia y la lista de procesos de la base de datos.
400	Account.QueryError	Instance %s query account error	Se produjo un error al consultar la cuenta de la instancia %s.
400	Connect.Timeout	Service can not connect to instance temporarily.	El servicio no puede conectarse temporalmente a la instancia.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	La operación falló. El ID de instancia del cluster especificado no existe.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	El DBClusterId especificado no existe en nuestros registros.
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.