DescribeAccounts - Tair (Redis® OSS-Compatible) - Centro de documentación de Alibaba Cloud

Consulta la información de una cuenta en una instancia de base de datos ApsaraDB for Tair (compatible con Redis® OSS) especificada.

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

kvstore:DescribeAccounts

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
InstanceId	string	Sí	El ID de la instancia.	r-bp1zxszhcgatnx****
AccountName	string	No	El nombre de la cuenta que se va a consultar.	demoaccount
SearchAccountName	string	No	La cadena de coincidencia aproximada para el nombre de la cuenta.	test
PageNumber	integer	No	El número de página.	1
PageSize	integer	No	El número de entradas por página.	100

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	6C9E114C-217C-4118-83C0-B4070222****
Accounts	object
Account	array<object>	La lista de información de cuentas de la instancia.
	array<object>	Los detalles de la cuenta.
AccountDescription	string	La descripción de la cuenta.	testdec
InstanceId	string	El ID de la instancia.	r-bp10noxlhcoim2****
AccountType	string	El tipo de cuenta. Valores válidos: Normal: cuenta estándar. Super: cuenta de superusuario.	Normal
AccountStatus	string	El estado de la cuenta. Valores válidos: Unavailable: no disponible. Available: disponible.	Available
AccountName	string	El nombre de la cuenta.	demoaccount
DatabasePrivileges	object
DatabasePrivilege	array<object>	La lista de privilegios de la cuenta.
	object	Los detalles de los privilegios de la cuenta.
AccountPrivilege	string	El privilegio de la cuenta. Valores válidos: RoleReadOnly: permiso de solo lectura. RoleReadWrite: permiso de lectura y escritura. Este es el valor predeterminado.	RoleReadWrite
Parameters	string	Los parámetros de la cuenta.	{"access-db-id":"1","cu-limit":"10"}
PageNumber	integer	El número de página.	100
PageSize	integer	El número de entradas por página.	1
TotalCount	integer	El número total de entradas.	10

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "6C9E114C-217C-4118-83C0-B4070222****",
  "Accounts": {
    "Account": [
      {
        "AccountDescription": "testdec",
        "InstanceId": "r-bp10noxlhcoim2****",
        "AccountType": "Normal",
        "AccountStatus": "Available",
        "AccountName": "demoaccount",
        "DatabasePrivileges": {
          "DatabasePrivilege": [
            {
              "AccountPrivilege": "RoleReadWrite"
            }
          ]
        },
        "Parameters": "{\"access-db-id\":\"1\",\"cu-limit\":\"10\"}"
      }
    ]
  },
  "PageNumber": 100,
  "PageSize": 1,
  "TotalCount": 10
}

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.