ListServerGroups - : Central de Documentação do Alibaba Cloud

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	ListServerGroups	A operação a ser executada. Defina o valor como ListServerGroups.
ServerGroupIds.N	String	Não	sgp-atstuj3rtoptyui****	O ID do grupo de servidores. Especifique até 20 IDs de grupos de servidores por solicitação.
ServerGroupNames.N	String	Não	NLB_ServerGroup	Os nomes dos grupos de servidores a consultar. Especifique até 20 nomes por solicitação.
ResourceGroupId	String	Não	rg-atstuj3rtop****	O ID do grupo de recursos ao qual o grupo de servidores pertence.
ServerGroupType	String	Não	Instance	O tipo de grupo de servidores. Valores válidos: Instance: permite adicionar servidores dos tipos Ecs, Ens e Eci. IP: permite adicionar servidores por endereço IP.
VpcId	String	Não	vpc-bp15zckdt37pq72zv****	O ID da Virtual Private Cloud (VPC) à qual o grupo de servidores pertence.
Tag.N.Key	String	Não	Test	A chave da tag. Especifique até 10 chaves de tag. A chave da tag pode ter até 64 caracteres e não pode conter `http://` ou `https://`. Não pode começar com `aliyun` ou `acs:`.
Tag.N.Value	String	Não	Test	O valor da tag. Especifique até 10 valores de tag. O valor da tag pode ter até 128 caracteres e não pode conter `http://` ou `https://`. Não pode começar com `aliyun` ou `acs:`.
NextToken	String	Não	FFmyTO70tTpLG6I3FmYAXGKPd****	O token que define o ponto inicial da consulta. Valores válidos: Se esta for a primeira consulta e não houver consultas subsequentes, ignore este parâmetro. Para enviar uma nova consulta, defina o valor como o NextToken retornado na última chamada.
MaxResults	Integer	Não	20	O número de entradas a retornar por página. Valores válidos: 1 a 100. Valor padrão: 20.
RegionId	String	Não	cn-hangzhou	O ID da região onde a instância NLB está implantada. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	54B28E3D-DF70-471B-AA93-08E683A1B45	O ID da solicitação.
ServerGroups	Array of ServerGroup		Os grupos de servidores.
RegionId	String	cn-hangzhou	O ID da região onde a instância NLB está implantada.
ServerGroupId	String	sgp-atstuj3rtoptyui****	O ID do grupo de servidores.
ServerGroupName	String	NLB_ServerGroup	O nome do grupo de servidores.
ServerGroupType	String	Instance	O tipo de grupo de servidores. Valores válidos: Instance: permite adicionar servidores dos tipos Ecs, Ens e Eci. IP: permite adicionar servidores por endereço IP.
AddressIPVersion	String	ipv4	A versão do protocolo. Valores válidos: ipv4: IPv4 DualStack: pilha dupla
VpcId	String	vpc-bp15zckdt37pq72zv****	O ID da VPC à qual o grupo de servidores pertence.
Scheduler	String	Wrr	O algoritmo de agendamento. Valores válidos: Wrr: servidores de back-end com pesos maiores recebem mais solicitações do que aqueles com pesos menores. rr: as solicitações são encaminhadas sequencialmente aos servidores de back-end. sch: o encaminhamento ocorre com base no hash do endereço IP de source. sch: solicitações do mesmo endereço IP de source vão para o mesmo servidor de back-end. tch: hash consistente baseado em quatro fatores (endereço IP de source, endereço IP de destino, porta de source e porta de destino). Solicitações com as mesmas informações nesses quatro fatores são encaminhadas ao mesmo servidor de back-end. qch: hash de QUIC ID. Solicitações com o mesmo QUIC ID são encaminhadas ao mesmo servidor de back-end.
Protocol	String	TCP	O protocolo usado para encaminhar solicitações aos servidores de back-end. Valores válidos: TCP, UDP e TCPSSL.
HealthCheck	Object		As configurações das verificações de integridade.
HealthCheckEnabled	Boolean	false	Indica se o recurso de verificação de integridade está ativado. Valores válidos: true: ativado false: desativado
HealthCheckType	String	TCP	O protocolo usado nas verificações de integridade. Valores válidos: TCP e HTTP.
HealthCheckConnectPort	Integer	200	A porta de back-end usada nas verificações de integridade. Valores válidos: 0 a 65535. O valor 0 indica o uso da porta do próprio servidor de back-end para as verificações.
HealthyThreshold	Integer	2	Número de verificações de integridade consecutivas bem-sucedidas necessárias para declarar um servidor de back-end não íntegro como íntegro. Nesse caso, o status muda de fail para success. Valores válidos: 2 a 10.
UnhealthyThreshold	Integer	3	Número de verificações de integridade consecutivas com falha necessárias para declarar um servidor de back-end íntegro como não íntegro. Nesse caso, o status muda de success para fail. Valores válidos: 2 a 10.
HealthCheckConnectTimeout	Integer	200	Tempo limite máximo da verificação de integridade. Unidade: segundos. Valores válidos: 1 a 300.
HealthCheckInterval	Integer	200	Intervalo entre duas verificações de integridade consecutivas. Unidade: segundos. Valores válidos: 5 a 50.
HealthCheckDomain	String	$SERVER_IP	Nome de domínio usado nas verificações de integridade. Valores válidos: $SERVER_IP: endereço IP privado de um servidor de back-end. domain: nome de domínio especificado. Deve ter de 1 a 80 caracteres e pode conter letras minúsculas, dígitos, hifens (-) e pontos (.). Nota Este parâmetro só tem efeito se HealthCheckType estiver definido como HTTP.
HealthCheckUrl	String	/test/index.html	Caminho para envio das solicitações de verificação de integridade. Nota Este parâmetro só tem efeito se HealthCheckType estiver definido como HTTP.
HealthCheckHttpCode	Array of String	http_2xx	Códigos de status HTTP considerados válidos nas verificações de integridade. Separe vários códigos por vírgula (,). Valores válidos: http_2xx, http_3xx, http_4xx e http_5xx. Nota Este parâmetro só tem efeito se HealthCheckType estiver definido como HTTP.
HttpCheckMethod	String	GET	Método HTTP usado nas verificações de integridade. Valores válidos: GET e HEAD. Nota Este parâmetro só tem efeito se HealthCheckType estiver definido como HTTP.
ConnectionDrainEnabled	Boolean	false	Indica se o esgotamento de conexão está ativado. Valores válidos: true: ativado false: desativado
ConnectionDrainTimeout	Integer	200	Tempo limite do esgotamento de conexão. Unidade: segundos. Valores válidos: 10 a 900.
PreserveClientIpEnabled	Boolean	true	Indica se a preservação do IP do cliente está ativada. Valores válidos: true: ativado false: desativado Nota Observação: Se AddressIPVersion estiver definido como ipv4, o valor padrão é true. Se AddressIPVersion estiver definido como ipv6, o único valor válido é false. O valor true terá suporte em versões futuras.
AnyPortEnabled	Boolean	false	Indica se o encaminhamento de solicitações para todas as portas está ativado. Valores válidos: true: ativado false: desativado
ResourceGroupId	String	rg-atstuj3rtop****	O ID do grupo de recursos ao qual o grupo de servidores pertence.
ServerGroupStatus	String	Available	Status do grupo de servidores. Valores válidos: Creating: criação em andamento. Available: disponível. Configuring: configuração em andamento.
AliUid	Long	165820696622****	UID da conta Alibaba Cloud.
Tags	Array of Tag		Tags adicionadas à instância NLB.
Key	String	Test	Chave da tag. Retorna no máximo 10 chaves. A chave pode ter até 64 caracteres e não pode conter `http://` ou `https://`. Não pode começar com `aliyun` ou `acs:`.
Value	String	Test	Valor da tag. Retorna no máximo 10 valores. O valor pode ter até 128 caracteres e não pode conter `http://` ou `https://`. Não pode começar com `aliyun` ou `acs:`.
RelatedLoadBalancerIds	Array of String	nlb-83ckzc8d4xlp8o****	Instâncias NLB associadas.
ServerCount	Integer	2	Número de servidores no grupo de servidores associado às instâncias NLB.
TotalCount	Integer	1	Número total de entradas retornadas.
NextToken	String	FFmyTO70tTpLG6I3FmYAXGKPd****	Token que define o ponto inicial da consulta. Valores válidos: Se NextToken estiver vazio, não há consultas subsequentes pendentes. Se houver retorno de NextToken, use esse valor como token para a próxima consulta.
MaxResults	Integer	20	Número de entradas retornadas por página. Valores válidos: 1 a 100.

Exemplos

Solicitações de exemplo

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

Respostas de sucesso de exemplo

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 erro

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.