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

Consulta as informações sobre um ou mais grupos consistentes com snapshot, como o status, o ID da instância associada e o progresso de criação do snapshot.

Descrição da operação

InstanceId, SnapshotGroupId.N e Status.N não são parâmetros de solicitação obrigatórios, mas você pode usá-los para criar uma lógica de filtro. A relação lógica entre esses parâmetros é E (AND).

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. Você pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
InstanceId	string	Não	O ID da instância.	i-j6ca469urv8ei629****
Name	string	Não	O nome do grupo consistente com snapshot.	testName
NextToken	string	Não	O token de consulta. Defina o valor como o valor de NextToken retornado na última chamada de API.	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	Não	O número de entradas por página para uma consulta paginada. Valor máximo: 100. Valor padrão: 10.	10
SnapshotGroupId	array	Não	Os IDs dos grupos consistentes com snapshot. Valores válidos de N: 1 a 10.	ssg-j6ciyh3k52qp7ovm****
	string	Não	Os IDs dos grupos consistentes com snapshot. Valores válidos de N: 1 a 10.	ssg-j6ciyh3k52qp7ovm****
Status	array	Não	O status do grupo consistente com snapshot. Valores válidos de N: 1 a 3. Valores válidos: progressing: O grupo consistente com snapshot está sendo criado. accomplished: O grupo consistente com snapshot foi criado. failed: Falha ao criar o grupo consistente com snapshot.	accomplished
	string	Não	O status do grupo consistente com snapshot. Valores válidos de N: 1 a 3. Valores válidos: progressing: O grupo consistente com snapshot está sendo criado. accomplished: O grupo consistente com snapshot foi criado. failed: Falha ao criar o grupo consistente com snapshot.	accomplished
AdditionalAttributes	array	Não	Este parâmetro não está disponível.	hide
	string	Não	Nota Este parâmetro não está disponível.	null
Tag	array<object>	Não	As tags do grupo consistente com snapshot.
	object	Não	As tags do grupo consistente com snapshot.
Key	string	Não	A chave da tag do grupo consistente com snapshot. Valores válidos de N: 1 a 20.	TestKey
Value	string	Não	O valor da tag do grupo consistente com snapshot. Valores válidos de N: 1 a 20.	TestValue
ResourceGroupId	string	Não	O ID do grupo de recursos ao qual o grupo consistente com snapshot pertence.	rg-bp67acfmxazb4p****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
NextToken	string	O token para a próxima consulta. Nota Se este parâmetro estiver vazio, nenhum outro dado será retornado.	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	O ID da solicitação.	3F9A4CC4-362F-469A-B9EF-B3204EF8AA3A
SnapshotGroups	object
SnapshotGroup	array<object>	A matriz de informações do grupo consistente com snapshot.
	array<object>	Os detalhes do grupo consistente com snapshot.
CreationTime	string	A hora de criação. A hora é exibida no formato yyyy-MM-ddTHH:mm:ssZ em UTC com base no padrão ISO 8601.	2021-03-23T10:58:48Z
Description	string	A descrição.	This is description.
InstanceId	string	O ID da instância à qual o grupo consistente com snapshot pertence. Este parâmetro é retornado apenas quando todos os snapshots de disco no grupo consistente com snapshot pertencem à mesma instância. Se vários snapshots de disco no grupo consistente com snapshot pertencerem a diferentes instâncias ECS, você pode visualizar o ID da instância à qual um único snapshot pertence usando o parâmetro `Snapshots.Snapshot.Tags.*` na resposta.	i-j6ca469urv8ei629****
Name	string	O nome do grupo consistente com snapshot.	testName
ProgressStatus	string	Nota Este parâmetro não está disponível.	null
ResourceGroupId	string	O ID do grupo de recursos ao qual o grupo consistente com snapshot pertence.	rg-bp67acfmxazb4p****
SnapshotGroupId	string	O ID do grupo consistente com snapshot.	ssg-j6ciyh3k52qp7ovm****
Snapshots	object
Snapshot	array<object>	A matriz de detalhes dos snapshots no grupo de consistência de snapshots.
	array<object>
Available	boolean	Indica se o snapshot pode ser usado para criar discos em nuvem, reverter discos em nuvem e compartilhar snapshots. Valores válidos: true: O snapshot está disponível. false: O snapshot não está disponível.	false
InstantAccess	boolean	Indica se o recurso de acesso instantâneo está ativo para o snapshot. Valores válidos: true: Ativado. Este recurso é ativado por padrão para discos em nuvem ESSD (SSD padrão). false: Desativado. O snapshot é um snapshot padrão para o qual o recurso de acesso instantâneo não está ativado. Nota [Deprecated] Os snapshots padrão de discos em nuvem ESSD (SSD padrão) são atualizados para acesso instantâneo por padrão. Você não precisa configurar este parâmetro e nenhuma taxa adicional é cobrada. instant access by default	true
InstantAccessRetentionDays	integer	O período de retenção do recurso de acesso instantâneo quando está ativo. Após o término do período de retenção, o snapshot é liberado automaticamente. Nota [Deprecated] Os snapshots padrão de discos em nuvem ESSD (SSD padrão) são atualizados para acesso instantâneo por padrão. Você não precisa configurar este parâmetro e nenhuma taxa adicional é cobrada. instant access by default	3
Progress	string	O progresso de criação do snapshot. Unidade: %.	100%
SnapshotId	string	O ID do snapshot.	s-j6cbzmrlbf09w72q****
SourceDiskId	string	O ID do disco em nuvem de origem. Se o disco em nuvem de origem do snapshot for liberado, este campo ainda será mantido.	d-j6c3ogynmvpi6wy7****
SourceDiskType	string	O tipo do disco em nuvem de origem. Valores válidos: system: disco em nuvem do sistema. data: disco em nuvem de dados.	system
Tags	object
Tag	array<object>	As tags de cada snapshot no grupo de consistência de snapshots. Por padrão, as tags contêm as informações de origem do snapshot.
	object
Key	string	A chave da tag para cada snapshot no grupo de consistência de snapshots. Os valores padrão de Key e Value fornecem as informações de origem do snapshot.	acs:ecs:createFrom
Value	string	O valor da tag para cada snapshot no grupo de consistência de snapshots. Os valores padrão de Key e Value fornecem as informações de origem do snapshot.	i-bp11qm0o3dk4iuc****
Status	string	O status do grupo consistente com snapshot. Valores válidos: progressing: O grupo consistente com snapshot está sendo criado. accomplished: O grupo consistente com snapshot foi criado. failed: Falha ao criar o grupo consistente com snapshot.	accomplished
Tags	object
Tag	array<object>	As tags do grupo consistente com snapshot.
	object
Key	string	A chave da tag do grupo consistente com snapshot.	TestKey
Value	string	O valor da tag do grupo consistente com snapshot.	TestValue

Exemplos

Resposta de sucesso

JSON formato

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "3F9A4CC4-362F-469A-B9EF-B3204EF8AA3A",
  "SnapshotGroups": {
    "SnapshotGroup": [
      {
        "CreationTime": "2021-03-23T10:58:48Z",
        "Description": "This is description.",
        "InstanceId": "i-j6ca469urv8ei629****",
        "Name": "testName",
        "ProgressStatus": "null",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "SnapshotGroupId": "ssg-j6ciyh3k52qp7ovm****",
        "Snapshots": {
          "Snapshot": [
            {
              "Available": false,
              "InstantAccess": true,
              "InstantAccessRetentionDays": 3,
              "Progress": "100%",
              "SnapshotId": "s-j6cbzmrlbf09w72q****",
              "SourceDiskId": "d-j6c3ogynmvpi6wy7****",
              "SourceDiskType": "system",
              "Tags": {
                "Tag": [
                  {
                    "Key": "acs:ecs:createFrom",
                    "Value": "i-bp11qm0o3dk4iuc****"
                  }
                ]
              }
            }
          ]
        },
        "Status": "accomplished",
        "Tags": {
          "Tag": [
            {
              "Key": "TestKey",
              "Value": "TestValue"
            }
          ]
        }
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	Duplicate.TagKey	The parameter Tag.N.Key contains duplicate values. Please remove the duplicate tag keys and try again.
400	InvalidParameter.NextToken	The specified parameter NextToken is not valid. Ensure you provide the NextToken value returned in the previous response.
403	InvalidSnapshotGroupId.MustBeOne	The size of SnapshotGroupIds must be one when AdditionalAttributes has SNAPSHOT_GROUP_PROGRESS_STATUS.
403	InvalidStatus.ValueNotSupported	The specified parameter status is not valid. The expected status is progressing; accomplished or failed.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	O RegionId especificado não existe. Verifique se o serviço está disponível na região.
404	InvalidInstanceId.NotFound	The InstanceId provided does not exist in our records.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.