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

Consulta os códigos de ativação criados e seu uso.

Descrição da operação

Você pode visualizar os dados retornados usando um dos seguintes métodos:

Método 1: Ao consultar a primeira página de forma paginada, você só precisa definir MaxResults para limitar o número de entradas retornadas. O valor NextToken na resposta é usado como o token para consultar a próxima página. Ao consultar a próxima página de forma paginada, defina o parâmetro NextToken com o valor NextToken obtido da resposta anterior e defina MaxResults para limitar o número de entradas retornadas.
Método 2: Defina PageSize para especificar o número de entradas a serem retornadas em cada página e defina PageNumber para especificar o número da página. Você pode usar apenas um dos métodos anteriores. Se você definir o parâmetro MaxResults ou NextToken, os parâmetros de solicitação PageSize e PageNumber se tornarão inválidos, e o valor TotalCount na resposta será inválido.

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

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região. Regiões suportadas: China (Qingdao), China (Pequim), China (Zhangjiakou), China (Hohhot), China (Ulanqab), China (Hangzhou), China (Xangai), China (Shenzhen), China (Heyuan), China (Guangzhou), China (Chengdu), Hong Kong (China), Singapura, Japão (Tóquio), EUA (Vale do Silício) e EUA (Virgínia). Você pode invocar a operação DescribeRegions para consultar informações como o ID da região.	cn-hangzhou
ActivationId	string	Não	O ID do código de ativação.	4ECEEE12-56F1-4FBC-9AB1-890F1234****
InstanceName	string	Não	O prefixo padrão do nome da instância.	test-InstanceName
PageNumber	integer	Não	O número da página. As páginas começam na página 1. Valor padrão: 1.	1
PageSize	integer	Não	As configurações para o número de entradas a serem retornadas em cada página durante a paginação em uma consulta paginada. Valor máximo: 50. Valor padrão: 10.	10
MaxResults	integer	Não	O número máximo de entradas a serem retornadas em cada página durante a paginação em uma consulta paginada. Valor máximo: 50. Valor padrão: 10.	10
NextToken	string	Não	O token de consulta. Defina o valor como o valor NextToken retornado da chamada de API anterior.	AAAAAdDWBF2****
ResourceGroupId	string	Não	O ID do grupo de recursos ao qual o código de ativação pertence.	rg-123******
Tag	array<object>	Não	A lista de tags.
	object	Não	A lista de tags.
Key	string	Não	A chave da tag do código de ativação da instância gerenciada (código dinâmico). Valores válidos de N: 1 a 20. A chave da tag não pode ser uma string vazia. Se você usar uma única tag para filtrar recursos, a contagem de recursos sob a tag não pode exceder 1.000. Se você usar várias tags para filtrar recursos, a contagem de recursos anexados a várias tags não pode exceder 1.000. Se a contagem de recursos exceder 1.000, você deve invocar a operação ListTagResources para consultar os recursos. A chave da tag pode ter até 64 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 código de ativação da instância gerenciada. 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
ActivationList	array<object>	Os códigos de ativação e suas informações de uso.
	array<object>
ActivationId	string	O ID do código de ativação.	4ECEEE12-56F1-4FBC-9AB1-890F1234****
CreationTime	string	A hora de criação. A hora segue o padrão ISO 8601 e é exibida em UTC.	2021-01-20T06:00:00Z
DeregisteredCount	integer	O número de instâncias desregistradas.	1
Description	string	A descrição do código de ativação.	This is description.
Disabled	boolean	Indica se o código de ativação está desativado.	false
InstanceCount	integer	O número máximo de vezes que o código de ativação pode ser usado para registrar instâncias gerenciadas.	1
InstanceName	string	O prefixo padrão do nome da instância.	test-InstanceName
IpAddressRange	string	Os endereços IP dos hosts que têm permissão para usar o código de ativação.	0.0.0.0/0
RegisteredCount	integer	O número de instâncias registradas.	1
ResourceGroupId	string	O ID do grupo de recursos ao qual o código de ativação pertence.	rg-123******
Tags	array<object>	As informações de tag do código de ativação da instância gerenciada.
	object	As informações de tag do código de ativação da instância gerenciada.
TagKey	string	A chave da tag do código de ativação da instância gerenciada.	owner
TagValue	string	O valor da tag do código de ativação da instância gerenciada.	zhangsan
TimeToLiveInHours	integer	O período de validade do código de ativação. Unidade: horas.	4
NextToken	string	O token de consulta retornado na resposta atual.	AAAAAdDWBF2****
PageNumber	integer	O número da página atual.	1
PageSize	integer	As configurações para o número de entradas retornadas por página durante a paginação em uma consulta paginada.	10
RequestId	string	O ID da solicitação.	4ECEEE12-56F1-4FBC-9AB1-890F74625134
TotalCount	integer	O número total de registros que atendem aos critérios de consulta condicional. Nota Ao realizar a paginação em uma consulta paginada usando os parâmetros MaxResults e NextToken, o valor TotalCount retornado não é significativo.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "ActivationList": [
    {
      "ActivationId": "4ECEEE12-56F1-4FBC-9AB1-890F1234****",
      "CreationTime": "2021-01-20T06:00:00Z",
      "DeregisteredCount": 1,
      "Description": "This is description.",
      "Disabled": false,
      "InstanceCount": 1,
      "InstanceName": "test-InstanceName",
      "IpAddressRange": "0.0.0.0/0",
      "RegisteredCount": 1,
      "ResourceGroupId": "rg-123******",
      "Tags": [
        {
          "TagKey": "owner",
          "TagValue": "zhangsan"
        }
      ],
      "TimeToLiveInHours": 4
    }
  ],
  "NextToken": "AAAAAdDWBF2****",
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "4ECEEE12-56F1-4FBC-9AB1-890F74625134",
  "TotalCount": 1
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	RegionId.ApiNotSupported	The api is not supported in this region.	Esta operação de API não é suportada na região especificada. Verifique se o valor do parâmetro RegionId está correto.
400	InvalidParam.PageNumber	The specified parameter is invalid.
400	InvalidParam.PageSize	The specified parameter is invalid.
400	InvalidTagKey.Malformed	The specified Tag.n.Key is not valid.	O parâmetro de chave de tag especificado é inválido.
400	InvalidTagValue.Malformed	The specified Tag.n.Value is not valid.	O parâmetro de valor da tag especificado é inválido.
400	NumberExceed.Tags	The Tags parameter number is exceed.	O número de tags excede o limite máximo. Você pode especificar até 20 tags para esta operação.
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	Existem chaves duplicadas nas tags. Certifique-se de que as chaves sejam únicas.
400	MissingParameter.TagKey	You must specify Tag.N.Key.	Especifique a chave da tag.
400	InvalidParameter.NextToken	The specified parameter NextToken is not valid.
400	InvalidParameter.MaxResults	The specified parameter MaxResults is not valid.	O parâmetro MaxResults especificado é inválido.
500	InternalError.Dispatch	An error occurred when you dispatched the request.	Ocorreu um erro ao enviar a solicitação. Tente novamente mais tarde.
403	InvalidParameterCharacter	The specified parameter %s contains illegal characters.
403	Operation.Forbidden	The operation is not permitted.	A operação não é permitida.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	O RegionId especificado não existe. Verifique se o produto está disponível nesta região.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.