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

Consulta os detalhes de uma garantia de elasticidade. Por exemplo, você pode consultar o status, o modo de correspondência, o modo de vigência, o horário de expiração e o número de instâncias utilizadas de uma garantia de elasticidade.

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:DescribeElasticityAssurances

get

*ElasticityAssurance.

acs:ecs:{#regionId}:{#accountId}:elasticityassurance/*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região à qual a garantia de elasticidade pertence. Você pode chamar DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
ResourceGroupId	string	Não	O ID do grupo de recursos. Ao usar este parâmetro para filtrar recursos, a contagem de recursos não pode exceder 1.000. Nota A filtragem pelo grupo de recursos padrão não é suportada.	rg-bp67acfmxazb4p****
Tag	array<object>	Não	A lista de pares chave-valor de tags vinculadas à garantia de elasticidade.
	object	Não	As informações da tag.
Key	string	Não	A chave da tag. N indica que você pode definir várias chaves de tag para filtragem. Valores válidos de N: 1 a 20. Se você usar uma única tag para filtrar recursos, a contagem de recursos com essa tag não pode exceder 1.000. Se você usar várias tags para filtrar recursos, a contagem de recursos que possuem todas as tags especificadas anexadas não pode exceder 1.000. Se a contagem de recursos exceder 1.000, chame a operação ListTagResources para consultar os recursos.	TestKey
Value	string	Não	O valor da tag. N indica que você pode especificar várias chaves de tag para filtragem. Valores válidos de N: 1 a 20.	TestValue
MaxResults	integer	Não	O número máximo de entradas por página para uma consulta paginada. Valor máximo: 100. Valor padrão: 10.	10
NextToken	string	Não	O token de paginação para a consulta de garantia de elasticidade. Obtenha o valor a partir do resultado da solicitação anterior.	caeba0bbb2be03f84eb48b699f0a4883
PrivatePoolOptions.Ids	string	Não	A lista de IDs de garantia de elasticidade. O valor pode ser uma matriz JSON que consiste em até 100 IDs. Separe vários IDs com vírgulas (,).	["eap-bp67acfmxazb4**", "eap-bp67acfmxazb5**"]
Platform	string	Não	Nota Este parâmetro foi descontinuado.	null
InstanceType	string	Não	O tipo de instância. Você pode usar o tipo de instância para consultar apenas garantias de elasticidade ativas. Garantias de elasticidade liberadas só podem ser consultadas usando PrivatePoolOptions.Ids.	ecs.c6.large
ZoneId	string	Não	O ID da zona na região à qual a garantia de elasticidade pertence.	cn-hangzhou-h
InstanceChargeType	string	Não	O método de cobrança da instância. Valores válidos: PostPaid. Apenas o modelo pós-pago é suportado. Valor padrão: PostPaid.	PostPaid
Status	string	Não	O status da garantia de elasticidade. Valores válidos: All: todos os estados. Deactived: a ser ativado. Este estado está em pré-visualização por convite. Preparing: sendo preparado. Prepared: a entrar em vigor. Active: em vigor. Released: liberado. Se você não especificar este parâmetro, as garantias de elasticidade em todos os estados, exceto Pending e Released, serão consultadas.	Active
PackageType	string	Não	O tipo da garantia de elasticidade. Valores válidos: ElasticityAssurance: garantia de elasticidade padrão. Este é o tipo quando RecurrenceRules não é especificado. TimeDivisionElasticityAssurance: garantia de elasticidade com divisão de tempo. Este é o tipo quando RecurrenceRules é especificado.	ElasticityAssurance

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
NextToken	string	O token de paginação para a próxima consulta.	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	O número total de entradas que correspondem às condições de consulta.	1
MaxResults	integer	O número máximo de entradas por página para a garantia de elasticidade.	10
ElasticityAssuranceSet	object
ElasticityAssuranceItem	array<object>	A coleção de detalhes da garantia de elasticidade.
	array<object>	Os detalhes da garantia de elasticidade.
Status	string	O status da garantia de elasticidade. Valores válidos: Preparing: sendo preparado. Prepared: a entrar em vigor. Active: em vigor. Released: liberado.	Active
PrivatePoolOptionsMatchCriteria	string	O modo de correspondência da garantia de elasticidade. Valores válidos: Open: modo aberto. O sistema corresponde automaticamente à capacidade de pools privados abertos quando as instâncias são iniciadas. Se nenhuma capacidade de pool privado correspondente estiver disponível, os recursos do pool público serão usados para iniciar as instâncias. Target: modo direcionado. As instâncias são iniciadas usando a capacidade do pool privado especificado. Se a capacidade do pool privado especificado não estiver disponível, as instâncias falharão ao iniciar.	Target
PrivatePoolOptionsId	string	O ID da garantia de elasticidade.	eap-bp1ir35kqtn8ywci****
UsedAssuranceTimes	integer	Nota Este parâmetro não está disponível publicamente.	0
LatestStartTime	string	Nota Este parâmetro não está disponível publicamente.	null
PrivatePoolOptionsName	string	O nome do serviço da garantia de elasticidade.	eapTestName
RegionId	string	O ID da região à qual a garantia de elasticidade pertence.	cn-hangzhou
EndTime	string	O horário de expiração da garantia de elasticidade. O horário está no padrão ISO 8601 em UTC.	2021-12-03T16:00Z
StartTime	string	O período de vigência da garantia de elasticidade. O horário está no formato ISO 8601 em UTC.	2020-12-03T05:25Z
Description	string	A descrição da garantia de elasticidade.	Esta é a descrição
ResourceGroupId	string	O ID do grupo de recursos.	rg-bp67acfmxazb4p****
TotalAssuranceTimes	string	O número total de vezes que a garantia de elasticidade é aplicada. Atualmente, apenas o modo ilimitado dentro do período de vigência é suportado.	Unlimited
AllocatedResources	object
AllocatedResource	array<object>	A lista de detalhes de alocação de recursos.
	array<object>	Os detalhes da alocação de recursos.
UsedAmount	integer	O número de instâncias utilizadas.	2
TotalAmount	integer	O número total de instâncias a serem reservadas para um único tipo de instância.	2
AvailableAmount	integer	Nota Este parâmetro não está disponível publicamente.	5
FailedAmount	integer	A capacidade com falha.	1
LockedAmount	integer	A capacidade bloqueada.	1
zoneId	string	O ID da zona na região à qual a garantia de elasticidade pertence.	cn-hangzhou-h
InstanceType	string	O tipo de instância.	ecs.c6.large
ElasticityAssuranceUsages	object
ElasticityAssuranceUsage	array<object>	Nota Este parâmetro não está disponível publicamente.
	object	Nota Este parâmetro não está disponível publicamente.
AccountId	string	Nota Este parâmetro não está disponível publicamente.	1144775968548340
ServiceName	string	Nota Este parâmetro não está disponível publicamente.	name
UsedAmount	integer	Nota Este parâmetro não está disponível publicamente.	1
Tags	object
Tag	array<object>	A lista de pares chave-valor de tags vinculadas à garantia de elasticidade.
	object	As informações do par chave-valor da tag vinculada à garantia de elasticidade.
TagValue	string	O valor da tag.	TestValue
TagKey	string	A chave da tag.	TestKey
InstanceChargeType	string	O método de cobrança da instância. Atualmente, apenas o modelo pós-pago é suportado. Valores válidos: PostPaid.	PostPaid
StartTimeType	string	O modo de vigência da garantia de elasticidade. Valores válidos: Now: entra em vigor imediatamente. Later: entra em vigor em um horário especificado.	Now
ElasticityAssuranceOwnerId	string	Nota Este parâmetro não está disponível publicamente.	e114477596854834
RecurrenceRules	object
RecurrenceRule	array<object>	A lista de regras de recorrência para a garantia de elasticidade com divisão de tempo.
	object	A regra de recorrência para a garantia de elasticidade com divisão de tempo.
RecurrenceType	string	O tipo de política da regra de recorrência. Valores válidos: Daily: recorrência diária. Weekly: recorrência semanal. Monthly: recorrência mensal.	Daily
RecurrenceValue	string	O valor da regra de recorrência. Valores válidos: Se RecurrenceType estiver definido como Daily, apenas um valor pode ser especificado. Valores válidos: 1 a 31. O valor indica o intervalo em dias. Se RecurrenceType estiver definido como Weekly, vários valores podem ser especificados e separados por vírgulas (,). Os valores para domingo, segunda-feira, terça-feira, quarta-feira, quinta-feira, sexta-feira e sábado são 0, 1, 2, 3, 4, 5 e 6. Por exemplo, `1,2` indica segunda e terça-feira. Se RecurrenceType estiver definido como Monthly, o formato é `A-B`. Valores válidos de A e B: 1 a 31. B deve ser maior ou igual a A. Por exemplo, `1-5` indica do 1º ao 5º dia de cada mês.	1
StartHour	integer	O período de vigência da garantia com divisão de tempo.	4
EndHour	integer	O horário de término da garantia com divisão de tempo.	10
PackageType	string	O tipo da garantia de elasticidade. Valores válidos: ElasticityAssurance: garantia de elasticidade padrão. TimeDivisionElasticityAssurance: garantia de elasticidade com divisão de tempo.	ElasticityAssurance

Exemplos

Resposta de sucesso

JSON formato

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1,
  "MaxResults": 10,
  "ElasticityAssuranceSet": {
    "ElasticityAssuranceItem": [
      {
        "Status": "Active",
        "PrivatePoolOptionsMatchCriteria": "Target",
        "PrivatePoolOptionsId": "eap-bp1ir35kqtn8ywci****",
        "UsedAssuranceTimes": 0,
        "LatestStartTime": "null",
        "PrivatePoolOptionsName": "eapTestName",
        "RegionId": "cn-hangzhou",
        "EndTime": "2021-12-03T16:00Z",
        "StartTime": "2020-12-03T05:25Z",
        "Description": "Esta é a descrição",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "TotalAssuranceTimes": "Unlimited",
        "AllocatedResources": {
          "AllocatedResource": [
            {
              "UsedAmount": 2,
              "TotalAmount": 2,
              "AvailableAmount": 5,
              "FailedAmount": 1,
              "LockedAmount": 1,
              "zoneId": "cn-hangzhou-h",
              "InstanceType": "ecs.c6.large",
              "ElasticityAssuranceUsages": {
                "ElasticityAssuranceUsage": [
                  {
                    "AccountId": "1144775968548340",
                    "ServiceName": "name",
                    "UsedAmount": 1
                  }
                ]
              }
            }
          ]
        },
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "InstanceChargeType": "PostPaid",
        "StartTimeType": "Now",
        "ElasticityAssuranceOwnerId": "e114477596854834",
        "RecurrenceRules": {
          "RecurrenceRule": [
            {
              "RecurrenceType": "Daily",
              "RecurrenceValue": "1",
              "StartHour": 4,
              "EndHour": 10
            }
          ]
        },
        "PackageType": "ElasticityAssurance"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	MissingParameter.RegionId	The specified RegionId should not be null.	O parâmetro RegionId não pode estar vazio.
400	InvalidParameter.Name	The specified PrivatePoolOptions.Name is invalid.
400	InvalidParameter.PrivatePoolOptions.Ids	The specified PrivatePoolOptions.Ids is invalid.
400	DedicatedHostNotSupported	DedicatedHost is not supported for PrivatePool.	Os pools privados não oferecem suporte a hosts dedicados.
400	SpotNotSupported	Spot is not supported for PrivatePool.	Os pools privados não oferecem suporte a instâncias spot.
400	ClassicNetworkNotSupported	Classic network is not supported for PrivatePool.	Os pools privados não oferecem suporte a instâncias do tipo de rede clássica.
400	Invalid.InstanceId	Instance does not exist.	A instância não corresponde a um pool privado.
400	Invalid.PrivatePoolOptions.MatchCriteria	Target mode does not support this operation.	O parâmetro PrivatePoolOptions.MatchCriteria especificado não corresponde ao pool privado.
400	MissingParameter.PrivatePoolOptions.Id	The specified PrivatePoolOptions.Id should not be null.	O parâmetro PrivatePoolOptions.Id não pode estar vazio.
400	Invalid.PrivatePoolOptions.Id	The PrivatePool does not exist.	O pool privado não existe.
400	Invalid.InstanceType	The InstanceType does not match the PrivatePool.	O tipo de instância não corresponde ao pool privado.
400	Invalid.InstanceChargeType	The InstanceChargeType does not match the PrivatePool.	O parâmetro InstanceChargeType especificado é inválido.
400	Invalid.ZoneId	The ZoneId does not match the PrivatePool.	A zona não corresponde ao pool privado.
400	Invalid.PrivatePoolOptions.status	The PrivatePool has been used up.	O status do pool privado especificado é inválido.
400	InvalidPlatform.ValueNotSupported	The Platform does not match the PrivatePool.	O parâmetro Platform especificado não corresponde ao pool privado.
400	InvalidAliUid	The PrivatePool does not belong to the user of the Instance.	O pool privado não pertence ao usuário que está criando a instância.
400	MissingParameter.PackageType	The specified parameter "PackageType" can not be empty.	O parâmetro PackageType não pode estar vazio.
400	MissingParameter.PrivatePoolOptions.Ids	The specified parameter "PrivatePoolOptions.Ids" can not be empty.	O parâmetro especificado PrivatePoolOptions.ids não pode estar vazio.
400	MissingParameter.InstanceCpuCoreCount	The specified parameter "InstanceCpuCoreCount" can not be empty.	O parâmetro especificado InstanceCpuCocount não pode estar vazio.
400	MissingParameter.InstanceAmount	The specified parameter "InstanceAmount" can not be empty.	O parâmetro especificado InstanceAmount não pode estar vazio.
400	MissingParameter.InstanceCpuCoreCountOrInstanceAmount	The specified parameter "InstanceCpuCoreCount" and "InstanceAmount" must not be empty at the same time.	Os parâmetros InstanceCpuCoreCount e InstanceAmount não podem estar ambos vazios.
400	Invalid.TooManyPrivatePoolOptions.Ids	Too many PrivatePoolOptions.Ids in this request.	O número de PrivatePoolOptions.Ids excede o limite superior.
400	Invalid.TooManyZoneIds	Too many ZoneIds in the request.	O número de ZoneIds excede o limite superior.
400	Invalid.TooManyInstanceTypes	Too many InstanceTypes in the request.	O número de InstanceTypes excede o limite superior.
400	Invalid.TooManyUnpaidPrivatePool	Too many PrivatePools create but still unpaid.	Vários pools privados não estão pagos.
400	Invalid.InstanceCpuCoreCountOrInstanceAmount	Both InstanceCpuCoreCount and InstanceAmount are provided.	Os parâmetros InstanceCpuCoreCount e InstanceAmount não precisam ser especificados ao mesmo tempo.
400	Invalid.PrivatePoolOptions.Ids	The specified parameter "PrivatePoolOptions.Ids" exist invalid element Id.	O ID do pool privado especificado não existe.
400	Invalid.PackageType	The specified parameter "PackageType" is invalid.	O parâmetro PackageType especificado é inválido.
400	Invalid.PrivatePool.Purchase	The PrivatePool has already paid.	O pool privado já está pago.
400	Invalid.AssuranceTimes.NotSupported	The value of AssuranceTimes is not supported.	O valor do parâmetro AssuranceTimes não é suportado.
400	RepeatStartPrivatePool	PrivatePool has already been started.	O pool privado já foi iniciado.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	Ocorreu um erro interno. Tente novamente.
404	InvalidResourceGroup.NotFound	The specified resource group is not found.	O grupo de recursos não foi encontrado nos registros.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.