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

Consulta una cuenta de base de datos de un clúster 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:DescribeAccounts

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-***************
AccountName	string	No	El nombre de la cuenta.	test_acc
NodeType	string	No	El tipo de nodo. Obligatorio cuando consulta la cuenta del nodo de búsqueda de PolarDB. Search	Search
PageNumber	integer	No	El número de página de la página devuelta. El valor debe ser un número entero mayor que 0. El valor predeterminado es 1.	1
PageSize	integer	No	El número de entradas devueltas por página. Valores válidos: 30 50 100 El valor predeterminado es 30.	30

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
PageRecordCount	integer	El número de entradas devueltas por página.	1
RequestId	string	El ID de la solicitud.	155462B9-205F-4FFC-BB43-4855FE******
PageNumber	integer	El número de página. Las páginas comienzan desde la página 1.	1
Accounts	array<object>	Los detalles de la cuenta.
	array<object>
AccountDescription	string	La descripción de la cuenta de base de datos.	test
AccountStatus	string	El estado de la cuenta de base de datos. 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	El periodo de validez 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>	La lista de permisos de base de datos otorgados a la cuenta.
	object
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 de base de datos.	test_acc

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"
    }
  ]
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.
400	Database.ConnectError	db instance %s connect failed, please check instance status and database processlist
400	Account.QueryError	Instance %s query account error
400	Connect.Timeout	Service can not connect to instance temporarily.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
404	InvalidDBClusterId.NotFound	The DBInstanceId 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.