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

Consulta as janelas de O&M.

Descrição da operação

Consulta as políticas de manutenção configuradas. Cada política contém dois atributos de manutenção:

Janela de tempo de manutenção: Um período especificado por você durante o qual as operações de O&M são executadas.
Ação de manutenção: A política de tratamento de instância inativa especificada por você.

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

list

*Todos os recursos.

*

Nenhuma

Sintaxe da solicitação

GET  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Enable	boolean	Não	Especifica se a janela está ativada ou desativada.	true
RegionId	string	Sim	O ID da região. Este parâmetro é exigido pelo SDK do Alibaba Cloud para fins de roteamento. No entanto, definir qualquer ID de região para esta operação não faz diferença. A resposta retorna todas as janelas de O&M que atendem às condições especificadas em todas as regiões.	cn-hangzhou
PlanWindowId	string	Não	O ID da janela de O&M.	pw-bp1jarob1aup7yvlrdt6
PlanWindowName	string	Não	O nome da janela de O&M.	WIndowName
TargetResourceGroupId	string	Não	O ID do grupo de recursos ao qual a janela de O&M se aplica.	rg-d85g5yocioezmdrll
TargetResourceTags	object	Não	As tags às quais a janela de O&M se aplica.
Value	string	Não	O valor da tag à qual a janela se aplica.	tagValue
Key	string	Não	A chave da tag à qual a janela se aplica.	tagKey
NextToken	string	Não	O token de paginação. Defina este parâmetro com o valor NextToken retornado na chamada de API anterior.	AAAAAdDWBF2
MaxResults	integer	Não	O número de entradas por página em uma consulta paginada. Valor máximo: 100. Valor padrão: Se o valor não for especificado ou for menor que 10, o valor padrão será 10. Se o valor for maior que 100, o valor padrão será 100.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
TotalCount	integer	O número total de entradas que correspondem às condições da solicitação. Este é um parâmetro opcional e pode não ser retornado por padrão.	1
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PlanMaintenanceWindowList	array<object>	A hora de criação.
	array<object>	O tipo de destino. Valores válidos: Tag ResourceGroup Instance AliUid
PlanWindowId	string	O ID da janela de O&M.	pw-bp1bqkbjb7h4j8zqzwvp
PlanWindowName	string	O nome da janela de O&M.	WindowName
Enable	boolean	Indica se a janela de O&M está ativada.	true
SupportMaintenanceAction	string	A ação de manutenção suportada.	Reboot
CreateTime	string	A hora em que a janela de O&M foi criada. A hora segue o padrão ISO 8601 em UTC. Formato: yyyy-MM-ddTHH:mm:ssZ.	2025-04-11T02:20:41Z
ModifiedTime	string	A hora em que a janela de O&M foi modificada pela última vez. A hora segue o padrão ISO 8601 em UTC. Formato: yyyy-MM-ddTHH:mm:ssZ.	2025-02-22 10:14:28 +0800
TimePeriod	object	O ciclo de recorrência da janela.
PeriodUnit	string	O tipo do ciclo de recorrência. Valores válidos: Daily: recorrência diária. Weekly: recorrência semanal.	Year
RangeList	array<object>	Os intervalos de tempo dentro do ciclo de recorrência da janela de O&M (em UTC).
	object
StartTime	string	A hora de início da janela de tempo de manutenção. Formato: "Dia da semana,HH:mm". Exemplo: Segunda-feira,22:00.	Monday,22:00
EndTime	string	A hora de término da janela de tempo de manutenção. Formato: "Dia da semana,HH:mm". Exemplo: Segunda-feira,22:00.	Monday,22:00
TargetResource	object	Os recursos aos quais a janela de O&M se aplica.
Scope	string	O tipo de recurso para o qual a janela de O&M está configurada.	Tag
ResourceGroupId	string	O ID do grupo de recursos ao qual a janela de O&M se aplica.	rg-aek2qxeteo7fr6y
Tags	array<object>	As tags às quais a janela de O&M se aplica.
	object
Key	string	A chave da tag.	tagKey
Value	string	O valor da tag.	tagValue
MinMaintenanceInterval	integer
NextToken	string	O token de consulta retornado por esta chamada.	AAAAAdDWBF2
MaxResults	integer	O número de entradas por página em uma consulta paginada. Valor máximo: 100. Valor padrão: Se o valor não for especificado ou for menor que 10, o valor padrão será 10. Se o valor for maior que 100, o valor padrão será 100.	10

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalCount": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PlanMaintenanceWindowList": [
    {
      "PlanWindowId": "pw-bp1bqkbjb7h4j8zqzwvp",
      "PlanWindowName": "WindowName",
      "Enable": true,
      "SupportMaintenanceAction": "Reboot",
      "CreateTime": "2025-04-11T02:20:41Z",
      "ModifiedTime": "2025-02-22 10:14:28 +0800",
      "TimePeriod": {
        "PeriodUnit": "Year",
        "RangeList": [
          {
            "StartTime": "Monday,22:00",
            "EndTime": "Monday,22:00"
          }
        ]
      },
      "TargetResource": {
        "Scope": "Tag",
        "ResourceGroupId": "rg-aek2qxeteo7fr6y",
        "Tags": [
          {
            "Key": "tagKey",
            "Value": "tagValue"
          }
        ]
      },
      "MinMaintenanceInterval": 0
    }
  ],
  "NextToken": "AAAAAdDWBF2",
  "MaxResults": 10
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
500	InternalError	Internal error.	Ocorreu um erro interno. Tente novamente.
403	AccessForbidden	User not authorized to operate on the specified resource.	Você não está autorizado a usar o recurso especificado.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.