DescribeBackupGatewayList - Data Management - Centro de documentación de Alibaba Cloud

Consulta una lista de puertas de enlace de respaldo en Database Backup Service (DBS).

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

dbs:DescribeBackupGatewayList

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Region	string	Sí	La región de la instancia de DBS. Valores válidos: cn-hangzhou: China (Hangzhou) cn-shanghai: China (Shanghai) cn-qingdao: China (Qingdao) cn-beijing: China (Beijing) cn-shenzhen: China (Shenzhen) cn-hongkong: China (Hong Kong) ap-southeast-1: Singapur cn-hangzhou-finance: Hangzhou Finance Cloud cn-shanghai-finance: Shanghai Finance Cloud cn-shenzhen-finance: Shenzhen Finance Cloud	cn-hangzhou
Identifier	string	No	El identificador único de la puerta de enlace de respaldo. Puede consultar varias puertas de enlace separando los identificadores con comas (,).	7213527653217
PageSize	integer	No	El número de registros por página. Valores válidos: 30 50 100 Nota El valor predeterminado es 30.	30
PageNum	integer	No	El número de página. El valor debe ser mayor o igual a 0 y no puede exceder el valor máximo de un entero. El valor predeterminado es 0.	1
ClientToken	string	No	Un token de cliente utilizado para garantizar la idempotencia de la solicitud. Esto evita solicitudes duplicadas.	ETnLKlblzczshOTUbOCzxxxxxxx

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
HttpStatusCode	integer	El código de estado HTTP.	200
PageNum	integer	El número de página.	1
RequestId	string	El ID de la solicitud.	46361705-8531-492F-807E-A97E482DD4A1
ErrCode	string	El código de error.	Param.NotFound
Success	boolean	Indica si la solicitud se realizó correctamente.	true
ErrMessage	string	El mensaje de error.	The specified parameter %s value is not valid
TotalPages	integer	El número total de páginas.	1
TotalElements	integer	El número total de puertas de enlace de respaldo.	0
PageSize	integer	El número de registros por página.	30
Items	object
BackupGateway	array<object>	Los detalles de la puerta de enlace de respaldo.
	object
DisplayName	string	El nombre para mostrar de la puerta de enlace de respaldo.	test
BackupGatewayCreateTime	integer	La hora en que se creó la puerta de enlace de respaldo. Es una marca de tiempo UNIX en milisegundos. Ejemplo: 1554560477000.	1554560477000
BackupGatewayId	string	El ID de la puerta de enlace de respaldo.	2321313123
Region	string	La región.	cn-hangzhou
Identifier	string	El identificador único de la puerta de enlace de respaldo.	sgdsajhdgu
SourceEndpointInternetIP	string	La dirección IP pública del host donde está instalada la puerta de enlace de respaldo.	XX.XX.XX.XX
BackupGatewayStatus	string	El estado de la puerta de enlace de respaldo. Valores válidos: ONLINE: La puerta de enlace está en línea. OFFLINE: La puerta de enlace está fuera de línea. STOPPED: La puerta de enlace está detenida. UPGRADING: La puerta de enlace se está actualizando.	ONLINE
SourceEndpointIntranetIP	string	La dirección IP interna del host donde está instalada la puerta de enlace de respaldo.	XX.XX.XX.XX
LastHeartbeatTime	integer	La hora del último latido. Es una marca de tiempo UNIX en milisegundos. Ejemplo: 1554560477000.	1554560477000
SourceEndpointHostname	string	El nombre de host del host donde está instalada la puerta de enlace de respaldo.	test

Ejemplos

Respuesta exitosa

JSON Formato

{
  "HttpStatusCode": 200,
  "PageNum": 1,
  "RequestId": "46361705-8531-492F-807E-A97E482DD4A1",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.  ",
  "TotalPages": 1,
  "TotalElements": 0,
  "PageSize": 30,
  "Items": {
    "BackupGateway": [
      {
        "DisplayName": "test",
        "BackupGatewayCreateTime": 1554560477000,
        "BackupGatewayId": "2321313123",
        "Region": "cn-hangzhou",
        "Identifier": "sgdsajhdgu",
        "SourceEndpointInternetIP": "XX.XX.XX.XX",
        "BackupGatewayStatus": "ONLINE",
        "SourceEndpointIntranetIP": "XX.XX.XX.XX",
        "LastHeartbeatTime": 1554560477000,
        "SourceEndpointHostname": "test"
      }
    ]
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
403	Request.Forbidden	Have no Permissions

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.