DescribeAutoProvisioningGroups - : 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 também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeAutoProvisioningGroups	Operação a ser executada. Defina o valor como DescribeAutoProvisioningGroups.
RegionId	String	Sim	cn-hangzhou	ID da região do grupo de provisionamento automático.
PageNumber	Integer	Não	1	Número da página. A numeração começa em 1. Valor padrão: 1.
PageSize	Integer	Não	2	Número de entradas por página. Valores válidos: 1 a 100. Valor padrão: 10.
AutoProvisioningGroupName	String	Não	testAutoProvisioningGroupName	Nome do grupo de provisionamento automático.
AutoProvisioningGroupId.N	String	Não	apg-sn54avj8htgvtyh8****	ID do grupo de provisionamento automático N.
AutoProvisioningGroupStatus.N	String	Não	active	Status do grupo de provisionamento automático N. Valores válidos: submitted: grupo criado, mas sem execução de tarefas de agendamento. active: grupo executando tarefas de agendamento. deleted: grupo excluído. deleted-running: grupo em processo de exclusão. modifying: grupo em processo de modificação.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
PageSize	Integer	10	Número de entradas por página.
RequestId	String	745CEC9F-0DD7-4451-9FE7-8B752F39****	ID da solicitação.
PageNumber	Integer	1	Número da página.
TotalCount	Integer	10	Quantidade de grupos de provisionamento automático consultados.
AutoProvisioningGroups	Array of AutoProvisioningGroup		Detalhes dos grupos de provisionamento automático.
AutoProvisioningGroup
CreationTime	String	2019-04-01T15:10:20Z	Horário de criação do grupo de provisionamento automático.
AutoProvisioningGroupName	String	EcsDocTest	Nome do grupo de provisionamento automático.
Status	String	submitted	Status do grupo de provisionamento automático. Valores válidos: submitted: grupo criado, mas sem execução de tarefas de agendamento. active: grupo executando tarefas de agendamento. deleted: grupo excluído. deleted-running: grupo em processo de exclusão. modifying: grupo em processo de modificação.
TerminateInstances	Boolean	false	Indica se as instâncias do grupo foram liberadas durante a exclusão do grupo. Valores válidos: true: libera as instâncias. false: apenas remove as instâncias do grupo, sem liberá-las.
MaxSpotPrice	Float	2	Preço máximo para instâncias preemptíveis no grupo de provisionamento automático. Nota Se os parâmetros MaxSpotPrice e LaunchTemplateConfig.N.MaxPrice forem especificados, o preço máximo corresponderá ao menor valor entre eles. O parâmetro LaunchTemplateConfig.N.MaxPrice é definido na criação do grupo e não pode ser modificado.
State	String	fulfilled	Status geral do agendamento de instâncias no grupo. Valores válidos: fulfilled: agendamento concluído e cluster de instâncias entregue. pending-fulfillment: instâncias em criação. pending-termination: instâncias em remoção. error: ocorreu uma exceção durante o agendamento e o cluster não foi entregue.
LaunchTemplateId	String	lt-bp1fgzds4bdogu03****	ID do modelo de execução associado ao grupo de provisionamento automático.
ValidFrom	String	2019-04-01T15:10:20Z	Horário de início do grupo de provisionamento automático. O grupo permanece válido até o momento especificado pelo parâmetro `ValidUntil`.
LaunchTemplateVersion	String	1	Versão do modelo de execução associado ao grupo de provisionamento automático.
TerminateInstancesWithExpiration	Boolean	true	Indica se as instâncias do grupo devem ser liberadas após a expiração do grupo. Valores válidos: true: libera as instâncias. false: apenas remove as instâncias do grupo, sem liberá-las.
RegionId	String	cn-hangzhou	ID da região do grupo de provisionamento automático.
ValidUntil	String	2019-06-01T15:10:20Z	Horário de expiração do grupo de provisionamento automático. O grupo entra em vigor no momento especificado pelo parâmetro `ValidFrom`.
AutoProvisioningGroupType	String	maintain	Tipo de entrega do grupo de provisionamento automático. Valores válidos: request: entrega única. Ao iniciar, o sistema entrega os clusters apenas uma vez. Em caso de falha, não há nova tentativa. maintain: entrega contínua. Ao iniciar, o grupo tenta entregar um cluster que atenda à capacidade alvo e monitora a capacidade em tempo real. Se a meta não for atingida, o grupo continua criando instâncias até alcançá-la.
AutoProvisioningGroupId	String	apg-sn54avj8htgvtyh8****	ID do grupo de provisionamento automático.
ExcessCapacityTerminationPolicy	String	termination	Indica se as instâncias excedentes devem ser liberadas quando a capacidade em tempo real superar a capacidade alvo e ocorrer redução de escala. Valores válidos: termination: libera as instâncias excedentes. no-termination: remove as instâncias excedentes do grupo, sem liberá-las.
LaunchTemplateConfigs	Array of LaunchTemplateConfig		Detalhes das configurações estendidas.
LaunchTemplateConfig
MaxPrice	Float	3	Preço máximo do tipo de instância especificado na configuração estendida.
Priority	Float	1	Prioridade do tipo de instância especificado na configuração estendida. O valor 0 indica a maior prioridade.
VSwitchId	String	vsw-sn5bsitu4lfzgc5o7****	ID do vSwitch especificado na configuração estendida.
WeightedCapacity	Float	2	Peso do tipo de instância especificado na configuração estendida.
InstanceType	String	ecs.g5.large	Tipo de instância especificado na configuração estendida.
SpotOptions	Object		Política relacionada a instâncias preemptíveis.
InstancePoolsToUseCount	Integer	2	Número de instâncias criadas pelo grupo selecionando o tipo de instância de menor preço. Nota Este parâmetro é definido na criação do grupo e não pode ser modificado.
AllocationStrategy	String	diversified	Política de provisionamento para instâncias preemptíveis. Valores válidos: lowest-price: otimização de custos. Utiliza os tipos de instância de menor custo para criar instâncias. diversified: distribuição equilibrada. Cria instâncias uniformemente nas zonas especificadas na configuração estendida.
InstanceInterruptionBehavior	String	stop	Ação a ser executada após a interrupção das instâncias preemptíveis excedentes. Valores válidos: stop: mantém as instâncias preemptíveis excedentes no estado parado. terminate: libera as instâncias preemptíveis excedentes.
PayAsYouGoOptions	Object		Políticas relacionadas a instâncias de pagamento conforme o uso.
AllocationStrategy	String	prioritized	Política para criação de instâncias de pagamento conforme o uso. Valores válidos: lowest-price: otimização de custos. Utiliza os tipos de instância de menor custo para criar instâncias. prioritized: baseada em prioridade. Cria instâncias conforme a prioridade definida pelo parâmetro LaunchTemplateConfig.N.Priority. Nota O parâmetro LaunchTemplateConfig.N.Priority é definido na criação do grupo e não pode ser modificado.
TargetCapacitySpecification	Object		Configurações da capacidade alvo do grupo de provisionamento automático.
SpotTargetCapacity	Float	20	Capacidade alvo de instâncias preemptíveis no grupo de provisionamento automático.
PayAsYouGoTargetCapacity	Float	30	Capacidade alvo de instâncias de pagamento conforme o uso no grupo de provisionamento automático.
DefaultTargetCapacityType	String	Spot	Método de faturamento das instâncias suplementares necessárias para atingir a capacidade alvo total (`TotalTargetCapacity`), que corresponde à soma da capacidade de pagamento conforme o uso (`PayAsYouGoTargetCapacity`) e da capacidade preemptível (`SpotTargetCapacity`). Valores válidos: PayAsYouGo: instâncias de pagamento conforme o uso Spot: instâncias preemptíveis
TotalTargetCapacity	Float	60	Capacidade alvo do grupo de provisionamento automático. Composta pelos seguintes elementos: PayAsYouGoTargetCapacity SpotTargetCapacity Capacidade suplementar além dos valores definidos em PayAsYouGoTargetCapacity e SpotTargetCapacity.

Exemplos

Solicitações de exemplo

https://ecs.aliyuncs.com/?Action=DescribeAutoProvisioningGroups
&AutoProvisioningGroupId.1=apg-sn54avj8htgvtyh8****
&RegionId=cn-hangzhou
&<Common request parameters>

Respostas de sucesso de exemplo

Formato XML

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

<DescribeAutoProvisioningGroups>
  <PageNumber>1</PageNumber>
  <TotalCount>1</TotalCount>
  <PageSize>10</PageSize>
  <RequestId>85331AC9-82C0-4604-9A14-048865BE****</RequestId>
  <AutoProvisioningGroups>
    <AutoProvisioningGroup>
      <TerminateInstancesWithExpiration>false</TerminateInstancesWithExpiration>
      <TerminateInstances>false</TerminateInstances>
      <ValidFrom>2019-06-17T15:22Z</ValidFrom>
      <AutoProvisioningGroupType>maintain</AutoProvisioningGroupType>
      <PayAsYouGoOptions>
        <AllocationStrategy>lowest-price</AllocationStrategy>
      </PayAsYouGoOptions>
      <AutoProvisioningGroupName>test61****</AutoProvisioningGroupName>
      <CreationTime></CreationTime>
      <ExcessCapacityTerminationPolicy>no-termination</ExcessCapacityTerminationPolicy>
      <Status>active</Status>
      <MaxSpotPrice>5</MaxSpotPrice>
      <LaunchTemplateVersion>1</LaunchTemplateVersion>
      <ValidUntil>2100-01-01T07:59Z</ValidUntil>
      <TargetCapacitySpecification>
        <SpotTargetCapacity>180</SpotTargetCapacity>
        <TotalTargetCapacity>300</TotalTargetCapacity>
        <PayAsYouGoTargetCapacity>120</PayAsYouGoTargetCapacity>
        <DefaultTargetCapacityType>PayAsYouGo</DefaultTargetCapacityType>
      </TargetCapacitySpecification>
      <State>fulfilled</State>
      <LaunchTemplateId>lt-uf657o6auob6aivd****</LaunchTemplateId>
      <RegionId>cn-shanghai</RegionId>
      <AutoProvisioningGroupId>apg-uf6c7pl7b30t4m98****</AutoProvisioningGroupId>
      <SpotOptions>
        <InstancePoolsToUseCount>1</InstancePoolsToUseCount>
        <InstanceInterruptionBehavior>terminate</InstanceInterruptionBehavior>
        <AllocationStrategy>lowest-price</AllocationStrategy>
      </SpotOptions>
      <LaunchTemplateConfigs>
        <LaunchTemplateConfig>
          <MaxPrice>3</MaxPrice>
          <WeightedCapacity>1</WeightedCapacity>
          <VSwitchId>vsw-uf6qbjwokzl67uqqf****</VSwitchId>
          <Priority>1</Priority>
          <InstanceType>ecs.c5.xlarge</InstanceType>
        </LaunchTemplateConfig>
        <LaunchTemplateConfig>
          <MaxPrice>2</MaxPrice>
          <WeightedCapacity>2</WeightedCapacity>
          <VSwitchId>vsw-uf6n6iy1ib39eqvph****</VSwitchId>
          <Priority>1</Priority>
          <InstanceType>ecs.g5.large</InstanceType>
        </LaunchTemplateConfig>
        <LaunchTemplateConfig>
          <MaxPrice>1</MaxPrice>
          <WeightedCapacity>3</WeightedCapacity>
          <VSwitchId>vsw-uf6gs8uerj5osels4****</VSwitchId>
          <Priority>1</Priority>
          <InstanceType>ecs.hfc5.large</InstanceType>
        </LaunchTemplateConfig>
      </LaunchTemplateConfigs>
    </AutoProvisioningGroup>
  </AutoProvisioningGroups>
</DescribeAutoProvisioningGroups>

Formato JSON

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

{
  "PageNumber" : 1,
  "TotalCount" : 1,
  "PageSize" : 10,
  "RequestId" : "85331AC9-82C0-4604-9A14-048865BE****",
  "AutoProvisioningGroups" : {
    "AutoProvisioningGroup" : {
      "TerminateInstancesWithExpiration" : false,
      "TerminateInstances" : false,
      "ValidFrom" : "2019-06-17T15:22Z",
      "AutoProvisioningGroupType" : "maintain",
      "PayAsYouGoOptions" : {
        "AllocationStrategy" : "lowest-price"
      },
      "AutoProvisioningGroupName" : "test61****",
      "CreationTime" : "",
      "ExcessCapacityTerminationPolicy" : "no-termination",
      "Status" : "active",
      "MaxSpotPrice" : 5,
      "LaunchTemplateVersion" : 1,
      "ValidUntil" : "2100-01-01T07:59Z",
      "TargetCapacitySpecification" : {
        "SpotTargetCapacity" : 180,
        "TotalTargetCapacity" : 300,
        "PayAsYouGoTargetCapacity" : 120,
        "DefaultTargetCapacityType" : "PayAsYouGo"
      },
      "State" : "fulfilled",
      "LaunchTemplateId" : "lt-uf657o6auob6aivd****",
      "RegionId" : "cn-shanghai",
      "AutoProvisioningGroupId" : "apg-uf6c7pl7b30t4m98****",
      "SpotOptions" : {
        "InstancePoolsToUseCount" : 1,
        "InstanceInterruptionBehavior" : "terminate",
        "AllocationStrategy" : "lowest-price"
      },
      "LaunchTemplateConfigs" : {
        "LaunchTemplateConfig" : [ {
          "MaxPrice" : 3,
          "WeightedCapacity" : 1,
          "VSwitchId" : "vsw-uf6qbjwokzl67uqqf****",
          "Priority" : 1,
          "InstanceType" : "ecs.c5.xlarge"
        }, {
          "MaxPrice" : 2,
          "WeightedCapacity" : 2,
          "VSwitchId" : "vsw-uf6n6iy1ib39eqvph****",
          "Priority" : 1,
          "InstanceType" : "ecs.g5.large"
        }, {
          "MaxPrice" : 1,
          "WeightedCapacity" : 3,
          "VSwitchId" : "vsw-uf6gs8uerj5osels4****",
          "Priority" : 1,
          "InstanceType" : "ecs.hfc5.large"
        } ]
      }
    }
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	MissingParamter.RegionId	The regionId should not be null.	RegionId é obrigatório.

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