DescribeAutoProvisioningGroups - Elastic Compute Service: Central de Documentação do Alibaba Cloud

Consulta um ou mais grupos de provisionamento automático.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

ecs:DescribeAutoProvisioningGroups

get

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região na qual o grupo de provisionamento automático está localizado.	cn-hangzhou
PageNumber	integer	Não	O número da página da lista a ser retornada em uma consulta paginada. Valor mínimo: 1. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página em uma consulta paginada. Valor máximo: 100. Valor padrão: 10.	2
AutoProvisioningGroupName	string	Não	O nome do grupo de provisionamento automático.	testAutoProvisioningGroupName
ResourceGroupId	string	Não	O ID do grupo de recursos ao qual o grupo de provisionamento automático pertence.	rg-bp67acfmxazb4p****
AutoProvisioningGroupId	array	Não	Os IDs dos grupos de provisionamento automático. Você pode especificar até 20 IDs de grupos de provisionamento automático.	apg-sn54avj8htgvtyh8****
	string	Não	O ID do grupo de provisionamento automático.	apg-sn54avj8htgvtyh8****
AutoProvisioningGroupStatus	array	Não	A lista de status dos grupos de provisionamento automático.	active
	string	Não	O status do grupo de provisionamento automático. Valores válidos: submitted: O grupo de provisionamento automático foi criado, mas ainda não começou a executar tarefas de agendamento. active: O grupo de provisionamento automático começou a executar tarefas de agendamento. deleted: O grupo de provisionamento automático foi excluído. delete-running: O grupo de provisionamento automático está sendo excluído. modifying: O grupo de provisionamento automático está sendo modificado.	active
AutoProvisioningGroupTypes	array	Não	O tipo do grupo de provisionamento automático. Valores válidos: request, maintain e candidate.
	string	Não	O tipo do grupo de provisionamento automático. Valores válidos: request, maintain e candidate.	request
Tag	array<object>	Não	As tags anexadas ao grupo de provisionamento automático.
	object	Não	As tags anexadas ao grupo de provisionamento automático.
Key	string	Não	A chave da tag do grupo de provisionamento automático. Valores válidos de N: 1 a 20. A chave da tag não pode ser uma string vazia. A chave da tag pode ter até 128 caracteres e não pode começar com aliyun ou acs:. A chave da tag não pode conter http:// ou https://.	TestKey
Value	string	Não	O valor da tag do grupo de provisionamento automático. Valores válidos de N: 1 a 20. O valor da tag pode ser uma string vazia. O valor da tag pode ter até 128 caracteres e não pode conter http:// ou https://.	TestValue

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
PageSize	integer	O número de entradas por página.	10
RequestId	string	O ID da solicitação.	745CEC9F-0DD7-4451-9FE7-8B752F39****
PageNumber	integer	O número da página.	1
TotalCount	integer	O número total de grupos de provisionamento automático consultados.	10
AutoProvisioningGroups	object
AutoProvisioningGroup	array<object>	Os detalhes do grupo de provisionamento automático.
	array<object>	Os detalhes do grupo de provisionamento automático.
CreationTime	string	A hora de criação. A hora é exibida no formato ISO 8601 em UTC.	2019-04-01T15:10:20Z
AutoProvisioningGroupName	string	O nome do grupo de provisionamento automático.	EcsDocTest
Status	string	O status do grupo de provisionamento automático. Valores válidos: submitted: O grupo de provisionamento automático foi criado, mas ainda não começou a executar tarefas de agendamento. active: O grupo de provisionamento automático começou a executar tarefas de agendamento. deleted: O grupo de provisionamento automático foi excluído. delete-running: O grupo de provisionamento automático está sendo excluído. modifying: O grupo de provisionamento automático está sendo modificado.	submitted
TerminateInstances	boolean	Especifica se as instâncias no grupo de provisionamento automático devem ser liberadas quando o grupo for excluído. Valores válidos: true: libera as instâncias no grupo. false: retém as instâncias no grupo.	false
MaxSpotPrice	number	O preço máximo das instâncias spot. Nota Quando MaxSpotPrice e LaunchTemplateConfig.N.MaxPrice são especificados, o valor menor tem precedência. LaunchTemplateConfig.N.MaxPrice é definido quando você cria o grupo de provisionamento automático e não pode ser modificado.	2
State	string	O status geral de agendamento do grupo de provisionamento automático. Valores válidos: fulfilled: A tarefa de agendamento foi concluída. pending-fulfillment: As instâncias estão sendo criadas. pending-termination: As instâncias estão sendo removidas. error: Ocorreu um erro durante o agendamento e a entrega do cluster de instâncias falhou.	fulfilled
LaunchTemplateId	string	O ID do modelo de inicialização de instância associado.	lt-bp1fgzds4bdogu03****
ValidFrom	string	A hora de início do grupo de provisionamento automático. O valor deste parâmetro e o valor de ValidUntil determinam o período de vigência do grupo de provisionamento automático.	2019-04-01T15:10:20Z
LaunchTemplateVersion	string	A versão do modelo de inicialização de instância associado.	1
TerminateInstancesWithExpiration	boolean	Especifica se as instâncias no grupo de provisionamento automático devem ser liberadas quando o grupo expirar. Valores válidos: true: As instâncias no grupo são liberadas. false: As instâncias são removidas do grupo.	true
RegionId	string	O ID da região.	cn-hangzhou
ValidUntil	string	A hora de expiração do grupo de provisionamento automático. Este parâmetro e ValidFrom determinam o período de validade.	2019-06-01T15:10:20Z
AutoProvisioningGroupType	string	O tipo de entrega. Valores válidos: request: única. O grupo de provisionamento automático entrega clusters de instâncias apenas na inicialização e não tenta novamente após falhas de agendamento. maintain: provisionamento contínuo. O grupo de provisionamento automático tenta entregar clusters de instâncias na inicialização e monitora a capacidade em tempo real. Se a capacidade alvo não for atingida, o grupo continua a criar instâncias ECS.	maintain
AutoProvisioningGroupId	string	O ID do grupo de provisionamento automático.	apg-sn54avj8htgvtyh8****
ExcessCapacityTerminationPolicy	string	Especifica se as instâncias reduzidas devem ser liberadas quando a capacidade em tempo real do grupo de provisionamento automático exceder a capacidade alvo e um evento de redução for acionado. Valores válidos: termination: libera as instâncias reduzidas. no-termination: apenas remove as instâncias reduzidas do grupo de provisionamento automático.	termination
ResourceGroupId	string	O ID do grupo de recursos ao qual o grupo de provisionamento automático pertence.	rg-bp67acfmxazb4p****
LaunchTemplateConfigs	object
LaunchTemplateConfig	array<object>	Os detalhes do modelo de inicialização estendido.
	object
MaxPrice	number	O preço máximo do tipo de instância especificado no modelo de inicialização estendido.	3
Priority	number	A prioridade do tipo de instância especificado no modelo de inicialização estendido. Um valor de 0 indica a prioridade mais alta.	1
VSwitchId	string	O ID do vSwitch especificado no modelo de inicialização estendido.	vsw-sn5bsitu4lfzgc5o7****
WeightedCapacity	number	O peso do tipo de instância especificado no modelo de inicialização estendido.	2
InstanceType	string	O tipo de instância especificado no modelo de inicialização estendido.	ecs.g5.large
SpotOptions	object	As políticas relacionadas às instâncias spot.
InstancePoolsToUseCount	integer	O número de tipos de instância com os preços mais baixos que o grupo de provisionamento automático usa para criar instâncias. Nota Este parâmetro é definido quando você cria o grupo de provisionamento automático e não pode ser modificado.	2
AllocationStrategy	string	A política para criação de instâncias spot. Valores válidos: lowest-price: política de otimização de custos. Tipo de instância spot com o menor preço. diversified: política de distribuição equilibrada de zonas. Cria instâncias spot nas zonas especificadas no modelo de inicialização estendido e as distribui uniformemente entre as zonas.	diversified
InstanceInterruptionBehavior	string	A ação a ser executada após a interrupção das instâncias spot. Valores válidos: stop: Mantém as instâncias no estado parado. terminate: Libera as instâncias.	stop
PayAsYouGoOptions	object	A política para instâncias pay-as-you-go.
AllocationStrategy	string	A política para criação de instâncias pay-as-you-go. Valores válidos: lowest-price: política de otimização de custos. O tipo de instância com o menor preço é selecionado. prioritized: política baseada em prioridade. As instâncias são criadas com base na prioridade especificada por LaunchTemplateConfig.N.Priority. Nota LaunchTemplateConfig.N.Priority é especificado quando você cria um grupo de provisionamento automático e não pode ser modificado.	prioritized
TargetCapacitySpecification	object	As configurações de capacidade alvo do grupo de provisionamento automático.
SpotTargetCapacity	number	A capacidade alvo das instâncias spot.	20
PayAsYouGoTargetCapacity	number	A capacidade alvo das instâncias pay-as-you-go.	30
DefaultTargetCapacityType	string	O método de cobrança da diferença de capacidade quando a soma de PayAsYouGoTargetCapacity e SpotTargetCapacity for menor que TotalTargetCapacity. Valores válidos: PayAsYouGo: instância pay-as-you-go. Spot: instância spot.	Spot
TotalTargetCapacity	number	A capacidade total alvo do grupo de provisionamento automático, que consiste nas três partes a seguir: PayAsYouGoTargetCapacity SpotTargetCapacity Diferença entre TotalTargetCapacity e a soma de PayAsYouGoTargetCapacity e SpotTargetCapacity	60
Tags	object
Tag	array<object>	As tags anexadas ao grupo de provisionamento automático.
	object	As tags anexadas ao grupo de provisionamento automático.
TagKey	string	A chave da tag do grupo de provisionamento automático. Valores válidos de N: 1 a 20. A chave da tag não pode ser uma string vazia. A chave da tag pode ter até 128 caracteres e não pode começar com aliyun ou acs:. A chave da tag não pode conter http:// ou https://.	TestKey
TagValue	string	O valor da tag do grupo de provisionamento automático. Valores válidos de N: 1 a 20. O valor da tag pode ser uma string vazia. O valor da tag pode ter até 128 caracteres e não pode conter http:// ou https://.	TestValue
CandidateOptions	object	As configurações relacionadas ao tipo candidato.
TimeoutMinutes	integer	O período de tempo limite durante o qual o grupo de provisionamento automático tenta fazer scale-out até a capacidade alvo. Unidade: minutos.	60
CapacitySpecification	object	A distribuição de capacidade atual do grupo de provisionamento automático.
PayAsYouGoCapacity	number	A capacidade atual de instâncias pay-as-you-go no grupo de provisionamento automático.	2
PrePaidCapacity	number	A capacidade atual de instâncias por assinatura no grupo de provisionamento automático.	0
SpotCapacity	number	A capacidade atual de instâncias spot no grupo de provisionamento automático.	3
TotalCapacity	number	A capacidade total atual de instâncias no grupo de provisionamento automático.	5
SuspendedProcesses	object
SuspendedProcess	array	O processo suspenso do grupo de provisionamento automático. Valores válidos: ScaleIn: processo de scale-in. ScaleOut: processo de scale-out.
	string	O processo suspenso do grupo de provisionamento automático. Valores válidos: ScaleIn: processo de scale-in. ScaleOut: processo de scale-out.	ScaleOut

Exemplos

Resposta de sucesso

JSON formato

{
  "PageSize": 10,
  "RequestId": "745CEC9F-0DD7-4451-9FE7-8B752F39****",
  "PageNumber": 1,
  "TotalCount": 10,
  "AutoProvisioningGroups": {
    "AutoProvisioningGroup": [
      {
        "CreationTime": "2019-04-01T15:10:20Z",
        "AutoProvisioningGroupName": "EcsDocTest",
        "Status": "submitted",
        "TerminateInstances": false,
        "MaxSpotPrice": 2,
        "State": "fulfilled",
        "LaunchTemplateId": "lt-bp1fgzds4bdogu03****",
        "ValidFrom": "2019-04-01T15:10:20Z",
        "LaunchTemplateVersion": "1",
        "TerminateInstancesWithExpiration": true,
        "RegionId": "cn-hangzhou",
        "ValidUntil": "2019-06-01T15:10:20Z",
        "AutoProvisioningGroupType": "maintain",
        "AutoProvisioningGroupId": "apg-sn54avj8htgvtyh8****",
        "ExcessCapacityTerminationPolicy": "termination",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "LaunchTemplateConfigs": {
          "LaunchTemplateConfig": [
            {
              "MaxPrice": 3,
              "Priority": 1,
              "VSwitchId": "vsw-sn5bsitu4lfzgc5o7****",
              "WeightedCapacity": 2,
              "InstanceType": "ecs.g5.large"
            }
          ]
        },
        "SpotOptions": {
          "InstancePoolsToUseCount": 2,
          "AllocationStrategy": "diversified",
          "InstanceInterruptionBehavior": "stop"
        },
        "PayAsYouGoOptions": {
          "AllocationStrategy": "prioritized"
        },
        "TargetCapacitySpecification": {
          "SpotTargetCapacity": 20,
          "PayAsYouGoTargetCapacity": 30,
          "DefaultTargetCapacityType": "Spot",
          "TotalTargetCapacity": 60
        },
        "Tags": {
          "Tag": [
            {
              "TagKey": "TestKey",
              "TagValue": "TestValue"
            }
          ]
        },
        "CandidateOptions": {
          "TimeoutMinutes": 60
        },
        "CapacitySpecification": {
          "PayAsYouGoCapacity": 2,
          "PrePaidCapacity": 0,
          "SpotCapacity": 3,
          "TotalCapacity": 5
        },
        "SuspendedProcesses": {
          "SuspendedProcess": [
            "ScaleOut"
          ]
        }
      }
    ]
  }
}

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.	O parâmetro RegionId não pode estar vazio.
400	InvalidName.Malformed	The specified parameter "AutoProvisioningGroupName" is not valid.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.