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

Consulta os detalhes das políticas de snapshot automático criadas em uma região especificada.

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

get

AutoSnapshotPolicy.

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

AutoSnapshotPolicy.

acs:ecs:{#regionId}:{#accountId}:snapshotpolicy/{#snapshotpolicyId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região das políticas de snapshot automático que você deseja consultar. Você pode chamar DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
AutoSnapshotPolicyId	string	Não	O ID da política de snapshot automático.	sp-bp67acfmxazb4ph****
AutoSnapshotPolicyName	string	Não	O nome da política de snapshot automático. O nome deve ter de 2 a 128 caracteres e pode conter caracteres classificados como letras no Unicode, incluindo caracteres chineses, letras em inglês e dígitos. O nome também pode conter dois-pontos (:), sublinhados (_), pontos (.) e hifens (-).	TestName
PageNumber	integer	Não	O número da página a ser retornada para a lista de políticas de snapshot automático. Valor mínimo: 1. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página para a lista de políticas de snapshot automático. Valor máximo: 100. Valor padrão: 10.	10
Tag	array<object>	Não	As tags.
	object	Não	As informações da tag.
Key	string	Não	A chave da tag da política de snapshot 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 da política de snapshot 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
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-aek2kkmhmhs****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
PageSize	integer	O número de entradas por página quando as políticas de snapshot automático são exibidas no modo de paginação.	10
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	O número da página da lista de políticas de snapshot automático.	1
TotalCount	integer	O número total de políticas de snapshot automático.	1
AutoSnapshotPolicies	object
AutoSnapshotPolicy	array<object>	Os detalhes das políticas de snapshot automático.
	array<object>	Os detalhes de uma política de snapshot automático.
AutoSnapshotPolicyId	string	O ID da política de snapshot automático.	sp-bp67acfmxazb4ph****
RegionId	string	O ID da região da política de snapshot automático.	cn-hangzhou
RepeatWeekdays	string	Os dias da semana em que os snapshots automáticos são criados. Valores válidos: 1 a 7, onde 1 indica segunda-feira. Vários dias podem ser especificados.	["6"]
TimePoints	string	Os horários em que os snapshots automáticos são criados. O horário é exibido em UTC+8. Unidade: horas. Valores válidos: 0 a 23, onde 0 indica 00:00 e 1 indica 01:00. Vários horários podem ser especificados. O valor do parâmetro é uma matriz JSON no formato `["0", "1", ... "23"]`. Um máximo de 24 horários pode ser especificado, separados por vírgulas (,).	["1"]
RetentionDays	integer	O período de retenção do snapshot automático. Unidade: dias. Valores válidos: -1: O snapshot automático é retido permanentemente. 1 a 65536: O snapshot automático é retido pelo número especificado de dias.	7
CreationTime	string	A hora em que a política de snapshot automático foi criada. A hora segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC.	2019-12-10T16:00Z
Status	string	O status da política de snapshot automático. Valores válidos: Normal: A política está normal. Expire: A política não pode ser usada porque sua conta tem um pagamento em atraso.	Normal
AutoSnapshotPolicyName	string	O nome da política de snapshot automático.	testAutoSnapshotPolicyName
EnableCrossRegionCopy	boolean	Nota Este parâmetro está em pré-visualização por convite e não está disponível publicamente.	false
TargetCopyRegions	string	Nota Este parâmetro está em pré-visualização por convite e não está disponível publicamente.	test
CopiedSnapshotsRetentionDays	integer	Nota Este parâmetro está em pré-visualização por convite e não está disponível publicamente.	0
CopyEncryptionConfiguration	object	A configuração de criptografia para replicação de snapshot entre regiões.
Encrypted	boolean	Indica se a criptografia está ativada para replicação de snapshot entre regiões. Valores válidos: true: A criptografia está ativada. false: A criptografia não está ativada. Valor padrão: false.	false
KMSKeyId	string	O ID da chave do Key Management Service (KMS) usada para replicação criptografada de snapshot entre regiões.	0e478b7a-4262-4802-b8cb-00d3fb40****
DiskNums	integer	O número de discos que têm esta política ativada. Nota Este parâmetro inclui apenas o número de discos cujo tipo de associação é AssociatedWithDisk.	1
VolumeNums	integer	O número de volumes estendidos que têm esta política ativada.	2
ResourceGroupId	string	O ID do grupo de recursos.	rg-aek2kkmhmhs****
Tags	object
Tag	array<object>	Os pares chave-valor da tag da política de snapshot automático.
	object	Os pares chave-valor da tag da política de snapshot automático.
TagKey	string	A chave da tag da política de snapshot automático.	TestKey
TagValue	string	O valor da tag da política de snapshot automático.	TestValue
AssociationType	string	O tipo de associação entre a política de snapshot automático e os recursos de destino. Valores válidos: AssociatedWithDisk: associado a discos AssociatedWithInstanceTag: associado a tags de instância	AssociatedWithDisk
TargetTags	object
TargetTag	array<object>	As tags dos recursos de destino. A política de snapshot automático corresponde aos recursos de destino com base nas tags.
	object	A tag do recurso de destino.
TagKey	string	A chave da tag.	env
TagValue	string	O valor da tag.	test
Type	string	O tipo da política de snapshot automático. Valores válidos: Custom: política de snapshot definida pelo usuário. System: política de snapshot definida pelo sistema.	Custom

Exemplos

Resposta de sucesso

JSON formato

{
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 1,
  "AutoSnapshotPolicies": {
    "AutoSnapshotPolicy": [
      {
        "AutoSnapshotPolicyId": "sp-bp67acfmxazb4ph****",
        "RegionId": "cn-hangzhou",
        "RepeatWeekdays": "[\"6\"]",
        "TimePoints": "[\"1\"]",
        "RetentionDays": 7,
        "CreationTime": "2019-12-10T16:00Z",
        "Status": "Normal",
        "AutoSnapshotPolicyName": "testAutoSnapshotPolicyName",
        "EnableCrossRegionCopy": false,
        "TargetCopyRegions": "test",
        "CopiedSnapshotsRetentionDays": 0,
        "CopyEncryptionConfiguration": {
          "Encrypted": false,
          "KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****"
        },
        "DiskNums": 1,
        "VolumeNums": 2,
        "ResourceGroupId": "rg-aek2kkmhmhs****",
        "Tags": {
          "Tag": [
            {
              "TagKey": "TestKey",
              "TagValue": "TestValue"
            }
          ]
        },
        "AssociationType": "AssociatedWithDisk",
        "TargetTags": {
          "TargetTag": [
            {
              "TagKey": "env",
              "TagValue": "test"
            }
          ]
        },
        "Type": "Custom"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidRegionId.NotFound	The specified RegionId does not exist.
400	InvalidTag.Mismatch	The specified Tag.n.Key and Tag.n.Value are not match.	O Tag.N.Key e o Tag.N.Value especificados não correspondem.
400	InvalidTagCount	The specified tags are beyond the permitted range.	A tag especificada está fora do intervalo válido.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.