ListServerGroups - - Centro de documentación de Alibaba Cloud

Consulta los grupos de servidores de las instancias de Network Load Balancer (NLB).

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, se recomienda llamar a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	ListServerGroups	La operación que desea ejecutar. Establezca el valor en ListServerGroups.
ServerGroupIds.N	String	No	sgp-atstuj3rtoptyui****	El ID del grupo de servidores. Puede especificar hasta 20 ID de grupos de servidores en cada solicitud.
ServerGroupNames.N	String	No	NLB_ServerGroup	Los nombres de los grupos de servidores que se van a consultar. Puede especificar hasta 20 nombres en cada solicitud.
ResourceGroupId	String	No	rg-atstuj3rtop****	El ID del resource group al que pertenece el grupo de servidores.
ServerGroupType	String	No	Instance	El tipo de grupo de servidores. Valores válidos: Instance: permite agregar servidores de los tipos Ecs, Ens y Eci. Ip: permite agregar servidores mediante la especificación de direcciones IP.
VpcId	String	No	vpc-bp15zckdt37pq72zv****	El ID de la virtual private cloud (VPC) a la que pertenece el grupo de servidores.
Tag.N.Key	String	No	Test	La clave de la etiqueta. Puede especificar hasta 10 claves de etiqueta. La clave de la etiqueta puede tener una longitud máxima de 64 caracteres y no puede contener `http://` ni `https://`. No puede comenzar con `aliyun` ni `acs:`.
Tag.N.Value	String	No	Test	El valor de la etiqueta. Puede especificar hasta 10 valores de etiqueta. El valor de la etiqueta puede tener una longitud máxima de 128 caracteres y no puede contener `http://` ni `https://`. No puede comenzar con `aliyun` ni `acs:`.
NextToken	String	No	FFmyTO70tTpLG6I3FmYAXGKPd****	El token que determina el punto de inicio de la consulta. Valores válidos: Si esta es su primera consulta y no se enviarán consultas posteriores, omita este parámetro. Si se va a enviar una consulta posterior, establezca el valor en el valor de NextToken devuelto en la última llamada.
MaxResults	Integer	No	20	El número de entradas que se devolverán en cada página. Valores válidos: de 1 a 100. Valor predeterminado: 20.
RegionId	String	No	cn-hangzhou	El ID de la región donde se despliega la instancia de NLB. Puede llamar a la operación DescribeRegions para consultar la lista de regiones más reciente.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
RequestId	String	54B28E3D-DF70-471B-AA93-08E683A1B45	El ID de la solicitud.
ServerGroups	Array of ServerGroup		Los grupos de servidores.
RegionId	String	cn-hangzhou	El ID de la región donde se despliega la instancia de NLB.
ServerGroupId	String	sgp-atstuj3rtoptyui****	El ID del grupo de servidores.
ServerGroupName	String	NLB_ServerGroup	El nombre del grupo de servidores.
ServerGroupType	String	Instance	El tipo de grupo de servidores. Valores válidos: Instance: permite agregar servidores de los tipos Ecs, Ens y Eci. Ip: permite agregar servidores mediante la especificación de direcciones IP.
AddressIPVersion	String	ipv4	La versión del protocolo. Valores válidos: ipv4: IPv4 DualStack: pila doble
VpcId	String	vpc-bp15zckdt37pq72zv****	El ID de la VPC a la que pertenece el grupo de servidores.
Scheduler	String	Wrr	El algoritmo de programación. Valores válidos: Wrr: los servidores backend con pesos más altos reciben más solicitudes que los servidores backend con pesos más bajos. rr: las solicitudes se reenvían a los servidores backend en secuencia. sch: las solicitudes se reenvían a los servidores backend según el hash de la dirección IP de origen. sch: las solicitudes de la misma dirección IP de origen se reenvían al mismo servidor backend. tch: hash de cuatro elementos, que especifica un hash consistente basado en cuatro factores: dirección IP de origen, dirección IP de destino, puerto de origen y puerto de destino. Las solicitudes que contienen la misma información basada en los cuatro factores se reenvían al mismo servidor backend. qch: hash de ID de QUIC. Las solicitudes que contienen el mismo ID de QUIC se reenvían al mismo servidor backend.
Protocol	String	TCP	El protocolo utilizado para reenviar solicitudes a los servidores backend. Valores válidos: TCP, UDP y TCPSSL.
HealthCheck	Object		Las configuraciones de las comprobaciones de estado.
HealthCheckEnabled	Boolean	false	Indica si la función de comprobación de estado está habilitada. Valores válidos: true: habilitado false: deshabilitado
HealthCheckType	String	TCP	El protocolo que se utiliza para las comprobaciones de estado. Valores válidos: TCP y HTTP.
HealthCheckConnectPort	Integer	200	El puerto backend que se utiliza para las comprobaciones de estado. Valores válidos: de 0 a 65535. Un valor de 0 indica que se utiliza el puerto de un servidor backend para las comprobaciones de estado.
HealthyThreshold	Integer	2	El número de veces que un servidor backend no saludable debe pasar consecutivamente las comprobaciones de estado antes de declararse saludable. En este caso, el estado de salud cambia de fail a success. Valores válidos: de 2 a 10.
UnhealthyThreshold	Integer	3	El número de veces que un servidor backend saludable debe fallar consecutivamente las comprobaciones de estado antes de declararse no saludable. En este caso, el estado de salud cambia de success a fail. Valores válidos: de 2 a 10.
HealthCheckConnectTimeout	Integer	200	El período máximo de tiempo de espera de una comprobación de estado. Unidad: segundos. Valores válidos: de 1 a 300.
HealthCheckInterval	Integer	200	El intervalo entre dos comprobaciones de estado consecutivas. Unidad: segundos. Valores válidos: de 5 a 50.
HealthCheckDomain	String	$SERVER_IP	El nombre de dominio que se utiliza para las comprobaciones de estado. Valores válidos: $SERVER_IP: la dirección IP privada de un servidor backend. domain: un nombre de dominio especificado. El nombre de dominio debe tener una longitud de 1 a 80 caracteres y puede contener letras minúsculas, dígitos, guiones (-) y puntos (.). Nota Este parámetro solo surte efecto si HealthCheckType se establece en HTTP.
HealthCheckUrl	String	/test/index.html	La ruta a la que se envían las solicitudes de comprobación de estado. Nota Este parámetro solo surte efecto si HealthCheckType se establece en HTTP.
HealthCheckHttpCode	Array of String	http_2xx	Los códigos de estado HTTP devueltos para las comprobaciones de estado. Varios códigos de estado HTTP se separan con comas (,). Valores válidos: http_2xx, http_3xx, http_4xx y http_5xx. Nota Este parámetro solo surte efecto si HealthCheckType se establece en HTTP.
HttpCheckMethod	String	GET	El método HTTP que se utiliza para las comprobaciones de estado. Valores válidos: GET y HEAD. Nota Este parámetro solo surte efecto si HealthCheckType se establece en HTTP.
ConnectionDrainEnabled	Boolean	false	Indica si el drenaje de conexiones está habilitado. Valores válidos: true: habilitado false: deshabilitado
ConnectionDrainTimeout	Integer	200	El período de tiempo de espera del drenaje de conexiones. Unidad: segundos. Valores válidos: de 10 a 900.
PreserveClientIpEnabled	Boolean	true	Indica si la preservación de la IP del cliente está habilitada. Valores válidos: true: habilitado false: deshabilitado Nota Nota: Si AddressIPVersion se establece en ipv4, el valor predeterminado es true. Si AddressIPVersion se establece en ipv6, el único valor válido es false. true será compatible en versiones posteriores.
AnyPortEnabled	Boolean	false	Indica si la función de reenvío de solicitudes a todos los puertos está habilitada. Valores válidos: true: habilitado false: deshabilitado
ResourceGroupId	String	rg-atstuj3rtop****	El ID del resource group al que pertenece el grupo de servidores.
ServerGroupStatus	String	Available	El estado del grupo de servidores. Valores válidos: Creating: el grupo de servidores se está creando. Available: el grupo de servidores está disponible. Configuring: el grupo de servidores se está configurando.
AliUid	Long	165820696622****	El UID de la cuenta de Alibaba Cloud.
Tags	Array of Tag		Las etiquetas agregadas a la instancia de NLB.
Key	String	Test	La clave de la etiqueta. Se devuelven como máximo 10 claves de etiqueta. La clave de la etiqueta puede tener una longitud máxima de 64 caracteres y no puede contener `http://` ni `https://`. No puede comenzar con `aliyun` ni `acs:`.
Value	String	Test	El valor de la etiqueta. Se devuelven como máximo 10 valores de etiqueta. El valor de la etiqueta puede tener una longitud máxima de 128 caracteres y no puede contener `http://` ni `https://`. No puede comenzar con `aliyun` ni `acs:`.
RelatedLoadBalancerIds	Array of String	nlb-83ckzc8d4xlp8o****	Las instancias de NLB.
ServerCount	Integer	2	El número de grupos de servidores asociados con las instancias de NLB.
TotalCount	Integer	1	El número de entradas devueltas.
NextToken	String	FFmyTO70tTpLG6I3FmYAXGKPd****	El token que determina el punto de inicio de la consulta. Valores válidos: Si NextToken está vacío, indica que no se enviará ninguna consulta posterior. Si se devuelve un valor de NextToken, dicho valor es el token utilizado para la siguiente consulta.
MaxResults	Integer	20	El número de entradas devueltas por página. Valores válidos: de 1 a 100.

Ejemplos

Solicitudes de ejemplo

http(s)://[Endpoint]/?Action=ListServerGroups
&ServerGroupIds=["sgp-atstuj3rtoptyui****"]
&ServerGroupNames=["NLB_ServerGroup"]
&ResourceGroupId=rg-atstuj3rtop****
&ServerGroupType=Instance
&VpcId=vpc-bp15zckdt37pq72zv****
&Tag=[{"Key":"Test","Value":"Test"}]
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&MaxResults=20
&RegionId=cn-hangzhou
&Common request parameters

Respuestas exitosas de ejemplo

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<ListServerGroupsResponse>
    <RequestId>54B28E3D-DF70-471B-AA93-08E683A1B45</RequestId>
    <ServerGroups>
        <RegionId>cn-hangzhou</RegionId>
        <ServerGroupId>sgp-atstuj3rtoptyui****</ServerGroupId>
        <ServerGroupName>NLB_ServerGroup</ServerGroupName>
        <ServerGroupType>Instance</ServerGroupType>
        <AddressIPVersion>ipv4</AddressIPVersion>
        <VpcId>vpc-bp15zckdt37pq72zv****</VpcId>
        <Scheduler>Wrr</Scheduler>
        <Protocol>TCP</Protocol>
        <HealthCheck>
            <HealthCheckEnabled>false</HealthCheckEnabled>
            <HealthCheckType>TCP</HealthCheckType>
            <HealthCheckConnectPort>200</HealthCheckConnectPort>
            <HealthyThreshold>2</HealthyThreshold>
            <UnhealthyThreshold>3</UnhealthyThreshold>
            <HealthCheckConnectTimeout>200</HealthCheckConnectTimeout>
            <HealthCheckInterval>200</HealthCheckInterval>
            <HealthCheckDomain>$SERVER_IP</HealthCheckDomain>
            <HealthCheckUrl>/test/index.html</HealthCheckUrl>
            <HealthCheckHttpCode>http2xx</HealthCheckHttpCode>
            <HttpCheckMethod>GET</HttpCheckMethod>
        </HealthCheck>
        <ConnectionDrainEnabled>false</ConnectionDrainEnabled>
        <ConnectionDrainTimeout>200</ConnectionDrainTimeout>
        <PreserveClientIpEnabled>true</PreserveClientIpEnabled>
        <AnyPortEnabled>false</AnyPortEnabled>
        <ResourceGroupId>rg-atstuj3rtop****</ResourceGroupId>
        <ServerGroupStatus>Available</ServerGroupStatus>
        <Tags>
            <Key>Test</Key>
            <Value>Test</Value>
        </Tags>
        <RelatedLoadBalancerIds>nlb-83ckzc8d4xlp8o****</RelatedLoadBalancerIds>
        <ServerCount>2</ServerCount>
    </ServerGroups>
    <TotalCount>1</TotalCount>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <MaxResults>20</MaxResults>
</ListServerGroupsResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "54B28E3D-DF70-471B-AA93-08E683A1B45",
  "ServerGroups" : [ {
    "RegionId" : "cn-hangzhou",
    "ServerGroupId" : "sgp-atstuj3rtoptyui****",
    "ServerGroupName" : "NLB_ServerGroup",
    "ServerGroupType" : "Instance",
    "AddressIPVersion" : "ipv4",
    "VpcId" : "vpc-bp15zckdt37pq72zv****",
    "Scheduler" : "Wrr",
    "Protocol" : "TCP",
    "HealthCheck" : {
      "HealthCheckEnabled" : false,
      "HealthCheckType" : "TCP",
      "HealthCheckConnectPort" : 200,
      "HealthyThreshold" : 2,
      "UnhealthyThreshold" : 3,
      "HealthCheckConnectTimeout" : 200,
      "HealthCheckInterval" : 200,
      "HealthCheckDomain" : "$SERVER_IP",
      "HealthCheckUrl" : "/test/index.html",
      "HealthCheckHttpCode" : [ "http2xx" ],
      "HttpCheckMethod" : "GET"
    },
    "ConnectionDrainEnabled" : false,
    "ConnectionDrainTimeout" : 200,
    "PreserveClientIpEnabled" : true,
    "AnyPortEnabled" : false,
    "ResourceGroupId" : "rg-atstuj3rtop****",
    "ServerGroupStatus" : "Available",
    "Tags" : [ {
      "Key" : "Test",
      "Value" : "Test"
    } ],
    "RelatedLoadBalancerIds" : [ "nlb-83ckzc8d4xlp8o****" ],
    "ServerCount" : 2
  } ],
  "TotalCount" : 1,
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults" : 20
}

Códigos de error

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.