DescribeLoadBalancers - Server Load Balancer - Centro de documentación de Alibaba Cloud

Consulta las instancias de SLB creadas.

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

slb:DescribeLoadBalancers

get

*LoadBalancer

acs:slb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de la región de la instancia de Classic Load Balancer (CLB). Puede llamar a la operación DescribeRegions para consultar los ID de región.	cn-hangzhou
ServerId	string	No	El ID del servidor backend que se agrega a la instancia de CLB.	i-2zebcbq******
AddressIPVersion	string	No	La versión de IP. Establezca el valor en ipv4 o ipv6.	ipv4
LoadBalancerStatus	string	No	El estado de la instancia. Valores válidos: inactive: La instancia está detenida. Los listeners de una instancia en este estado no reenvían tráfico. active: La instancia está en ejecución. Este es el estado predeterminado de una instancia después de su creación. locked: La instancia está bloqueada. Una instancia entra en estado bloqueado después de caducar. Este estado dura siete días. No puede realizar operaciones en la instancia. La instancia no reenvía tráfico, pero su dirección IP y otras configuraciones se conservan.	active
LoadBalancerId	string	No	El ID de la instancia de CLB. Puede especificar hasta 10 ID, separados por comas (,).	lb-bp1b6c719dfa****
LoadBalancerName	string	No	El nombre de la instancia de CLB. El nombre debe tener entre 1 y 80 caracteres de longitud. Debe comenzar con una letra o un carácter chino. Puede contener letras, dígitos, puntos (.), guiones bajos (_) y guiones (-). Puede especificar hasta 10 nombres. Separe varios nombres con comas (,).	test
ServerIntranetAddress	string	No	La dirección IP interna del servidor backend agregado. Puede especificar varias direcciones IP. Sepárelas con comas (,).	10.XX.XX.102
AddressType	string	No	El tipo de red de la instancia de CLB. Valores válidos: internet: Una instancia de CLB orientada a Internet. El sistema asigna una dirección IP pública a la instancia. La instancia puede reenviar solicitudes desde Internet. intranet: Una instancia de CLB orientada a la red interna. El sistema asigna una dirección IP privada a la instancia. La instancia solo puede reenviar solicitudes dentro de redes internas.	intranet
InternetChargeType	string	No	El método de facturación de la instancia de CLB orientada a Internet. Valores válidos: paybybandwidth: pago por ancho de banda. paybytraffic: pago por transferencia de datos.	paybytraffic
VpcId	string	No	El ID de la nube privada virtual (VPC) a la que pertenece la instancia de CLB.	vpc-bp1aevy8sof****
VSwitchId	string	No	El ID del vSwitch al que pertenece la instancia de CLB.	vsw-bp12mw1f8k3****
NetworkType	string	No	El tipo de red de la instancia de CLB orientada a la red interna. Valores válidos: vpc: una VPC. classic: una red clásica.	vpc
Address	string	No	La dirección de servicio de la instancia de CLB.	192.168.XX.XX
MasterZoneId	string	No	El ID de la zona principal de la instancia de CLB.	cn-hangzhou-b
SlaveZoneId	string	No	El ID de la zona secundaria de la instancia de CLB. La función multizona no está disponible para los usuarios de Alibaba Finance Cloud.	cn-hangzhou-d
Tags	string	No	Las etiquetas que se agregan a la instancia de CLB. El valor es un diccionario JSON que consta de claves de etiqueta y valores de etiqueta. Puede agregar hasta 10 etiquetas en cada solicitud.	[{"tagKey":"Key1","tagValue":"Value1"}]
PayType	string	No	El método de facturación de la instancia de CLB. Valores válidos: PayOnDemand: pago por uso.	PayOnDemand
ResourceGroupId	string	No	El ID del grupo de recursos.	rg-acfmxazb4p****
PageNumber	integer	No	El número de la página que se devolverá.	1
PageSize	integer	No	El número de entradas que se devolverán en cada página. Valores válidos: 1 a 100. Nota Si establece PageSize, también debe establecer PageNumber.	50
Tag	array<object>	No	La lista de etiquetas.
	object	No	La lista de etiquetas.
Key	string	No	La clave de la etiqueta N. Valores válidos de N: 1 a 20. La clave de la etiqueta no puede ser una cadena vacía. La clave de la etiqueta puede tener hasta 64 caracteres de longitud y no puede comenzar con `aliyun` o `acs:`. No puede contener `http://` o `https://`.	FinanceDept
Value	string	No	El valor de la etiqueta N. Valores válidos de N: 1 a 20. El valor de la etiqueta puede ser una cadena vacía. El valor de la etiqueta puede tener hasta 128 caracteres de longitud. No puede comenzar con `aliyun` o `acs:`. No puede contener `http://` o `https://`.	FinanceJoshua

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	8B9DB03B-ED39-5DB8-9C9F-1ED5F548D61E
PageNumber	integer	El número de la página devuelta.	1
PageSize	integer	El número de entradas devueltas en la página actual.	50
TotalCount	integer	El número total de instancias que cumplen con las condiciones de filtro.	1
LoadBalancers	object
LoadBalancer	array<object>	La lista de instancias de CLB.
	array<object>	La lista de instancias de CLB.
VpcId	string	El ID de la VPC en la que se despliega la instancia de CLB orientada a la red interna.	vpc-25dvzy9f8****
CreateTimeStamp	integer	La marca de tiempo que indica cuándo se creó la instancia.	1504147745000
LoadBalancerId	string	El ID de la instancia de CLB.	lb-bp1b6c719dfa****
CreateTime	string	La hora en que se creó la instancia. La hora tiene el formato `YYYY-MM-DDThh:mm:ssZ`.	2021-12-02T02:49:05Z
PayType	string	El método de facturación de la instancia de CLB. Valores válidos: PayOnDemand: pago por uso.	PayOnDemand
AddressType	string	El tipo de red de la instancia. Valores válidos: internet: Una instancia de CLB orientada a Internet. El sistema asigna una dirección IP pública a la instancia. La instancia puede reenviar solicitudes desde Internet. intranet: Una instancia de CLB orientada a la red interna. El sistema asigna una dirección IP privada a la instancia. La instancia solo puede reenviar solicitudes dentro de redes internas.	intranet
NetworkType	string	El tipo de red de la instancia de CLB orientada a la red interna. Valores válidos: vpc: una VPC. classic: una red clásica.	vpc
AddressIPVersion	string	La versión de IP. Valores válidos: ipv4 y ipv6.	ipv4
LoadBalancerName	string	El nombre de la instancia de CLB.	lb-bp1o94dp5i6ea****
Bandwidth	integer	El ancho de banda máximo del listener. Unidad: Mbit/s.	-1
Address	string	La dirección de servicio de la instancia de CLB.	100.XX.XX.28
SlaveZoneId	string	El ID de la zona secundaria de la instancia.	cn-hangzhou-d
MasterZoneId	string	El ID de la zona principal de la instancia.	cn-hangzhou-b
InternetChargeTypeAlias	string	El método de facturación de la instancia de CLB orientada a Internet. Valores válidos: paybybandwidth: pago por ancho de banda. paybytraffic: pago por transferencia de datos.	paybybandwidth
LoadBalancerSpec	string	La especificación de la instancia de CLB. Nota Las instancias de pago por transferencia de datos no tienen especificación. Se devuelve el valor predeterminado slb.lcu.elastic.	slb.s1.small
RegionId	string	El ID de la región de la instancia de CLB.	cn-hangzhou
ModificationProtectionReason	string	El motivo por el cual está habilitado el modo de solo lectura de configuración. El motivo debe tener entre 1 y 80 caracteres de longitud. Debe comenzar con una letra o un carácter chino. Puede contener letras, dígitos, puntos (.), guiones bajos (_) y guiones (-). Nota Este parámetro es válido solo si `ModificationProtectionStatus` se establece en ConsoleProtection.	ManagedInstance
ModificationProtectionStatus	string	El estado del modo de solo lectura de configuración: NonProtection: El modo de solo lectura de configuración está deshabilitado. Después de deshabilitar el modo, el valor de `ModificationProtectionReason` se borra. ConsoleProtection: El modo de solo lectura de configuración está habilitado. Nota Si el valor es ConsoleProtection, el modo de solo lectura de configuración está habilitado. No puede modificar la configuración de la instancia en la consola de CLB. Sin embargo, puede llamar a operaciones de API para modificar la configuración de la instancia.	ConsoleProtection
VSwitchId	string	El ID del vSwitch en la VPC donde se despliega la instancia de CLB orientada a la red interna.	vsw-255ecr****
LoadBalancerStatus	string	El estado de la instancia de CLB. Valores válidos: inactive: La instancia está detenida. Los listeners de una instancia en este estado no reenvían tráfico. active: La instancia está en ejecución. Este es el estado predeterminado de una instancia después de su creación. locked: La instancia está bloqueada.	active
ResourceGroupId	string	El ID del grupo de recursos.	rg-atstuj3r****
InternetChargeType	string	El método de facturación de la instancia orientada a Internet. Valores válidos: 3: pago por ancho de banda. 4: pago por transferencia de datos.	3
DeleteProtection	string	Indica si la protección contra eliminación está habilitada para la instancia de CLB. Valores válidos: on: habilitada. off: deshabilitada.	off
RegionIdAlias	string	El nombre de la región donde se despliega la instancia de CLB.	cn-hangzhou
Tags	object
Tag	array<object>	La lista de etiquetas.
	object	La lista de etiquetas.
TagValue	string	El valor de la etiqueta.	testvalue
TagKey	string	La clave de la etiqueta.	testkey

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "8B9DB03B-ED39-5DB8-9C9F-1ED5F548D61E",
  "PageNumber": 1,
  "PageSize": 50,
  "TotalCount": 1,
  "LoadBalancers": {
    "LoadBalancer": [
      {
        "VpcId": "vpc-25dvzy9f8****",
        "CreateTimeStamp": 1504147745000,
        "LoadBalancerId": "lb-bp1b6c719dfa****",
        "CreateTime": "2021-12-02T02:49:05Z",
        "PayType": "PayOnDemand",
        "AddressType": "intranet",
        "NetworkType": "vpc",
        "AddressIPVersion": "ipv4",
        "LoadBalancerName": "lb-bp1o94dp5i6ea****",
        "Bandwidth": -1,
        "Address": "100.XX.XX.28",
        "SlaveZoneId": "cn-hangzhou-d",
        "MasterZoneId": "cn-hangzhou-b",
        "InternetChargeTypeAlias": "paybybandwidth",
        "LoadBalancerSpec": "slb.s1.small",
        "RegionId": "cn-hangzhou",
        "ModificationProtectionReason": "ManagedInstance",
        "ModificationProtectionStatus": "ConsoleProtection",
        "VSwitchId": "vsw-255ecr****",
        "LoadBalancerStatus": "active",
        "ResourceGroupId": "rg-atstuj3r****",
        "InternetChargeType": "3",
        "DeleteProtection": "off",
        "RegionIdAlias": "cn-hangzhou",
        "Tags": {
          "Tag": [
            {
              "TagValue": "testvalue",
              "TagKey": "testkey"
            }
          ]
        }
      }
    ]
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	InvalidTag	The specified tags is invalid.
400	TooManyResult	fuzzy query retrieve too many instances.
400	LocationServiceTimeout	Location service connection timeout. Please try again later.
403	UnauthorizedRegion	The specified region of is not authorized.	The specified region of is not authorized.

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.