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

Esta API retorna o status de renovação automática e o período de renovação de uma ou mais instâncias ECS por assinatura.

Descrição da operação

Esta API suporta apenas instâncias por assinatura. Chamar esta API para uma instância pay-as-you-go retorna um erro.
Antes de configurar a renovação automática ou manual para uma instância, consulte seu status de renovação para verificar se a renovação automática já está ativada.

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

list

Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

Instance

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Não	Os IDs das instâncias. Você pode especificar até 100 instâncias por assinatura por vez. Separe vários IDs de instância com vírgulas. Nota Você deve especificar `InstanceId` ou `RenewalStatus`.	i-bp18x3z4hc7bixhx**,i-bp1g6zv0ce8oghu7**
RegionId	string	Sim	O ID da região. Você pode chamar DescribeRegions para visualizar a lista mais recente de regiões da Alibaba Cloud.	cn-hangzhou
RenewalStatus	string	Não	O status de renovação automática da instância. Valores válidos: AutoRenewal: A renovação automática está ativada. Normal: A renovação automática está desativada. NotRenewal: A instância não será renovada. O sistema não envia lembretes de expiração, mas envia um lembrete de não renovação três dias antes da data de expiração. Para renovar uma instância ECS com este status, você deve primeiro chamar ModifyInstanceAutoRenewAttribute para alterar seu status para `Normal`. Em seguida, você pode renovar a instância manualmente ou ativar a renovação automática.	AutoRenewal
PageSize	string	Não	O número de entradas por página. Valor máximo: 100. Valor padrão: 10.	10
PageNumber	string	Não	O número da página a ser retornada. Valor mínimo: 1. Valor padrão: 1.	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O corpo da resposta.
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	O número da página.	1
PageSize	integer	O número de entradas por página.	10
TotalCount	integer	O número total de instâncias retornadas.	6
InstanceRenewAttributes	object	Os atributos de renovação automática das instâncias.
InstanceRenewAttribute	array<object>	Uma matriz de objetos `InstanceRenewAttribute`.
	object
PeriodUnit	string	The unit of the auto-renewal duration.	week
Duration	integer	The auto-renewal duration.	1
RenewalStatus	string	The auto-renewal status of the instance. Valid values: AutoRenewal: The instance is configured for automatic renewal. Normal: Automatic renewal is disabled. You can manually renew the instance or enable auto-renewal. NotRenewal: The instance will not be renewed. The system does not send expiration notifications, but sends a non-renewal notification three days before the expiration date. To enable renewal for an ECS instance with this status, you must first call ModifyInstanceAutoRenewAttribute to change its status to `Normal`. You can then manually renew the instance or enable auto-renewal.	Normal
InstanceId	string	The instance ID.	i-bp18x3z4hc7bixhx****
AutoRenewEnabled	boolean	Indicates whether auto-renewal is enabled.	false
EnableExpectedRenewDay	boolean

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 6,
  "InstanceRenewAttributes": {
    "InstanceRenewAttribute": [
      {
        "PeriodUnit": "week",
        "Duration": 1,
        "RenewalStatus": "Normal",
        "InstanceId": "i-bp18x3z4hc7bixhx****",
        "AutoRenewEnabled": false,
        "EnableExpectedRenewDay": false
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	Throttling	Request was denied due to request throttling.
403	MissingParameter.InstanceId	InstanceId should not be null.	The InstanceId parameter is required.
403	InvalidParameter.ToManyInstanceIds	InstanceId should be less than 100.
403	IncorrectInstanceStatus	The current status of the resource does not support this operation.
403	ChargeTypeViolation	Pay-As-You-Go instances do not support this operation.	The operation is not supported by pay-as-you-go instances. Check the billing method of the instance.
403	InvalidParameter.RenewalStatus	The specified parameter RenewalStatus is not valid.	The specified RenewalStatus parameter is invalid.
403	InvalidParameter.RenewalStatusInstanceId	The parameter RenewalStatus and InstanceId can not be both empty.	The RenewalStatus and InstanceId parameters are required.
403	InvalidParameter.PageSize	The specified parameter PageSize is not valid.	The PageSize parameter is invalid.
403	InvalidParameter.PageNumber	The specified parameter PageNumber is not valid.	The specified PageNumber parameter is invalid.
403	InvalidParameter.InvalidInstanceId	The specified InstanceId does not exist.	The specified InstanceId does not exist.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.