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

Consulta informações sobre um ou mais grupos consistentes de snapshots, como status, ID da instância e 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 lógica de filtro. Os parâmetros têm uma relação lógica 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

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

get

SnapshotGroup.

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

SnapshotGroup.

acs:ecs:{#regionId}:{#accountId}:snapshotgroup/{#snapshotgroupId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região. Você pode chamar 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 de snapshots.	testName
NextToken	string	Não	O token de paginação. Defina este parâmetro com o valor NextToken retornado na chamada de API anterior.	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	Não	O número máximo de entradas por página em uma consulta paginada.	10
SnapshotGroupId	array	Não	O ID do grupo consistente de snapshots. Valores válidos de N: 1 a 10.	ssg-j6ciyh3k52qp7ovm****
	string	Não	O ID do grupo consistente de snapshots. Valores válidos de N: 1 a 10.	ssg-j6ciyh3k52qp7ovm****
Status	array	Não	O status do grupo consistente de snapshots. Valores válidos de N: 1 a 3. Valores válidos:	accomplished
	string	Não	O status do grupo consistente de snapshots. Valores válidos de N: 1 a 3. Valores válidos:	accomplished
AdditionalAttributes	array	Não	Este parâmetro não está disponível publicamente.	hide
	string	Não	Nota Este parâmetro não está disponível publicamente.	null
Tag	array<object>	Não	Os pares chave-valor de tag do grupo consistente de snapshots.
	object	Não	Os pares chave-valor de tag do grupo consistente de snapshots.
Key	string	Não	A chave da tag do grupo consistente de snapshots. Valores válidos de N: 1 a 20.	TestKey
Value	string	Não	O valor da tag do grupo consistente de snapshots. Valores válidos de N: 1 a 20.	TestValue
ResourceGroupId	string	Não	O ID do grupo de recursos ao qual o grupo consistente de snapshots pertence.	rg-bp67acfmxazb4p****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
NextToken	string	O token de paginação para a próxima consulta.	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	O ID da solicitação.	3F9A4CC4-362F-469A-B9EF-B3204EF8AA3A
SnapshotGroups	object
SnapshotGroup	array<object>	As informações sobre os grupos consistentes de snapshots.
	array<object>	Os detalhes do grupo consistente de snapshots.
SnapshotGroupId	string	O ID do grupo consistente de snapshots.	ssg-j6ciyh3k52qp7ovm****
InstanceId	string	O ID da instância à qual o grupo consistente de snapshots pertence. Este parâmetro é retornado apenas quando todos os snapshots de disco no grupo consistente de snapshots pertencem à mesma instância. Se os snapshots de disco no grupo consistente de snapshots pertencerem a diferentes instâncias ECS, você pode verificar o parâmetro `Snapshots.Snapshot.Tags.*` na resposta para visualizar o ID da instância de cada snapshot individual no grupo.	i-j6ca469urv8ei629****
Status	string	O status do grupo consistente de snapshots. Valores válidos:	accomplished
ProgressStatus	string	Nota Este parâmetro não está disponível publicamente.	null
Name	string	O nome do grupo consistente de snapshots.	testName
Description	string	A descrição.	Esta é uma descrição
CreationTime	string	A hora de criação. A hora segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC.	2021-03-23T10:58:48Z
ResourceGroupId	string	O ID do grupo de recursos ao qual o grupo consistente de snapshots pertence.	rg-bp67acfmxazb4p****
Tags	object
Tag	array<object>	Os pares chave-valor de tag do grupo consistente de snapshots.
	object
Key	string	A chave da tag do grupo consistente de snapshots.	TestKey
Value	string	O valor da tag do grupo consistente de snapshots.	TestValue
Snapshots	object
Snapshot	array<object>	As informações sobre os snapshots no grupo consistente de snapshots.
	array<object>
SnapshotId	string	O ID do snapshot.	s-j6cbzmrlbf09w72q****
SourceDiskId	string	O ID do disco de origem. Este campo é mantido mesmo que o disco de origem tenha sido liberado.	d-j6c3ogynmvpi6wy7****
SourceDiskType	string	O tipo do disco de origem. Valores válidos:	system
Available	boolean	Indica se o snapshot pode ser usado para criar discos, reverter discos ou compartilhar snapshots. Valores válidos:	false
Progress	string	O progresso de criação do snapshot, em porcentagem.	100%
InstantAccess	boolean	Indica se o acesso instantâneo ao snapshot está ativado. Valores válidos:	true
InstantAccessRetentionDays	integer	O período de retenção do recurso de acesso instantâneo ao snapshot. Após o término do período de retenção, o snapshot é liberado automaticamente.	3
Tags	object
Tag	array<object>	Os pares chave-valor de tag de cada snapshot no grupo consistente de snapshots. Por padrão, as informações de origem do snapshot estão incluídas.
	object
Key	string	A chave da tag de cada snapshot no grupo consistente de snapshots. Os valores padrão de Key e Value contêm as informações de origem do snapshot.	acs:ecs:createFrom
Value	string	O valor da tag de cada snapshot no grupo consistente de snapshots. Os valores padrão de Key e Value contêm as informações de origem do snapshot.	i-bp11qm0o3dk4iuc****

Exemplos

Resposta de sucesso

JSON formato

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

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	Existem chaves duplicadas nas tags. Mantenha as chaves únicas.
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.	As informações da região são inválidas.
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.