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

Observações de uso

Você pode especificar vários parâmetros de solicitação, como InstanceId, SnapshotGroupId.N e Status.N, para a consulta. Os parâmetros especificados têm relação lógica AND. Apenas os parâmetros definidos são incluídos nas condições de filtro.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeSnapshotGroups	A operação a ser executada. Defina o valor como DescribeSnapshotGroups.
RegionId	String	Sim	cn-hangzhou	O ID da região dos grupos consistentes de snapshots. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.
InstanceId	String	Não	i-j6ca469urv8ei629****	O ID da instância.
Name	String	Não	testName	O nome do grupo consistente de snapshots.
NextToken	String	Não	caeba0bbb2be03f84eb48b699f0a4883	Token de paginação usado na próxima solicitação para recuperar uma nova página de resultados. Não é necessário especificar este parâmetro na primeira solicitação. Especifique o token obtido na consulta anterior como valor de NextToken.
MaxResults	Integer	Não	10	Número de entradas por página. Valores válidos: 1 a 100. Valor padrão: 10.
SnapshotGroupId.N	String	Não	ssg-j6ciyh3k52qp7ovm****	ID do grupo consistente de snapshots N. Valores válidos de N: 1 a 10.
Status.N	String	Não	accomplished	Status do grupo consistente de snapshots N. Valores válidos de N: 1 a 3. Valores válidos: progressing: o grupo consistente de snapshots está sendo criado. accomplished: o grupo consistente de snapshots foi criado. failed: falha ao criar o grupo consistente de snapshots.
AdditionalAttributes.N	String	Não	null	Nota Este parâmetro não está disponível publicamente.
Tag.N.Key	String	Não	TestKey	Chave da tag N do grupo consistente de snapshots. Valores válidos de N: 1 a 20.
Tag.N.Value	String	Não	TestValue	Valor da tag N do grupo consistente de snapshots. Valores válidos de N: 1 a 20.
ResourceGroupId	String	Não	rg-bp67acfmxazb4p****	ID do grupo de recursos do grupo consistente de snapshots.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
NextToken	String	caeba0bbb2be03f84eb48b699f0a4883	Token de paginação. Pode ser usado na próxima solicitação para recuperar uma nova página de resultados. Nota Se este parâmetro estiver vazio, nenhum dado adicional será retornado.
RequestId	String	3F9A4CC4-362F-469A-B9EF-B3204EF8AA3A	ID da solicitação.
SnapshotGroups	Array of SnapshotGroup		Detalhes dos grupos consistentes de snapshots.
SnapshotGroup
Status	String	accomplished	Status do grupo consistente de snapshots N. Valores válidos: progressing: o grupo consistente de snapshots está sendo criado. accomplished: o grupo consistente de snapshots foi criado. failed: falha ao criar o grupo consistente de snapshots.
CreationTime	String	2021-03-23T10:58:48Z	Horário em que o grupo consistente de snapshots foi criado.
Description	String	This is description.	Descrição do grupo consistente de snapshots.
ProgressStatus	String	null	Nota Este parâmetro não está disponível publicamente.
SnapshotGroupId	String	ssg-j6ciyh3k52qp7ovm****	ID do grupo consistente de snapshots.
InstanceId	String	i-j6ca469urv8ei629****	ID da instância do grupo consistente de snapshots. Este parâmetro tem valor apenas quando todos os snapshots de disco no grupo pertencem à mesma instância. Se os snapshots de disco pertencerem a instâncias diferentes, use os parâmetros iniciados com `Snapshots.Snapshot.Tags.` na resposta para visualizar o ID da instância à qual cada snapshot do grupo pertence.
Name	String	testName	Nome do grupo consistente de snapshots.
ResourceGroupId	String	rg-bp67acfmxazb4p****	ID do grupo de recursos ao qual o grupo consistente de snapshots pertence.
Tags	Array of Tag		Tags do grupo consistente de snapshots.
Tag
Key	String	TestKey	Chave da tag do grupo consistente de snapshots.
Value	String	TestValue	Valor da tag do grupo consistente de snapshots.
Snapshots	Array of Snapshot		Detalhes dos snapshots no grupo consistente de snapshots.
Snapshot
SourceDiskId	String	d-j6c3ogynmvpi6wy7****	ID do disco de source. Este parâmetro é mantido mesmo após a liberação do disco de source do snapshot.
Progress	String	100%	Progresso da tarefa de criação do snapshot. Unidade: porcentagem (%).
Available	Boolean	false	Indica se o snapshot pode ser usado para criar ou reverter discos. Valores válidos: true false
InstantAccessRetentionDays	Integer	3	Período de retenção do recurso de acesso instantâneo. Após o término desse período, o snapshot é liberado automaticamente.
SnapshotId	String	s-j6cbzmrlbf09w72q****	ID do snapshot.
InstantAccess	Boolean	true	Indica se o recurso de acesso instantâneo está ativado. Valores válidos: true: o recurso de acesso instantâneo está ativado. Esse recurso só pode ser ativado para SSDs aprimorados (ESSDs). false: o recurso de acesso instantâneo está desativado. O snapshot é um snapshot normal com o recurso de acesso instantâneo desativado.
SourceDiskType	String	system	Tipo do disco de source. Valores válidos: system: disco do sistema data: disco de dados
Tags	Array of Tag		Tags dos snapshots no grupo consistente de snapshots. O valor padrão contém os detalhes da instância à qual o grupo consistente de snapshots pertence.
Tag
Key	String	acs:ecs:createFrom	Chave da tag de cada snapshot no grupo consistente de snapshots. Os valores padrão de Key e Value contêm os detalhes da instância à qual o grupo consistente de snapshots pertence.
Value	String	i-bp11qm0o3dk4iuc****	Valor da tag de cada snapshot no grupo consistente de snapshots. Os valores padrão de Key e Value contêm os detalhes da instância à qual o grupo consistente de snapshots pertence.

Exemplos

Exemplos de solicitações

https://ecs.aliyuncs.com/?Action=DescribeSnapshotGroups
&RegionId=cn-hangzhou
&SnapshotGroupId.1=ssg-j6ciyh3k52qp7ovm****
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeSnapshotGroupsResponse>
    <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
    <RequestId>3F9A4CC4-362F-469A-B9EF-B3204EF8AA3A</RequestId>
    <SnapshotGroups>
        <SnapshotGroup>
            <Status>accomplished</Status>
            <Description>This is description.</Description>
            <InstanceId/>
            <CreationTime>2021-03-23T10:58:48Z</CreationTime>
            <SnapshotGroupId>ssg-j6ciyh3k52qp7ovm****</SnapshotGroupId>
            <ResourceGroupId>rg-bp67acfmxazb4p****</ResourceGroupId>
            <Name>testName</Name>
            <Tags>
                <Tag>
                    <Value>TestValue</Value>
                    <Key>TestKey</Key>
                </Tag>
            </Tags>
            <Snapshots>
                <Snapshot>
                    <SnapshotId>s-j6cbzmrlbf09w72q****</SnapshotId>
                    <Progress>100%</Progress>
                    <Available>false</Available>
                    <InstantAccessRetentionDays>3</InstantAccessRetentionDays>
                    <SourceDiskType>system</SourceDiskType>
                    <SourceDiskId>d-j6c3ogynmvpi6wy7****</SourceDiskId>
                    <Tags>
                        <Tag>
                            <Value>i-bp11qm0o3dk4iuc****</Value>
                            <Key>acs:ecs:createFrom</Key>
                        </Tag>
                    </Tags>
                </Snapshot>
                <Snapshot>
                    <SnapshotId>s-bp1fgrjucs8wr31****</SnapshotId>
                    <Progress>100%</Progress>
                    <SourceDiskType>system</SourceDiskType>
                    <SourceDiskId>d-bp1bcsu5leotddp****</SourceDiskId>
                    <Tags>
                        <Tag>
                            <Value>i-bp1emqgxsg88zdl****</Value>
                            <Key>acs:ecs:createFrom</Key>
                        </Tag>
                    </Tags>
                </Snapshot>
            </Snapshots>
        </SnapshotGroup>
    </SnapshotGroups>
</DescribeSnapshotGroupsResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

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

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
403	InvalidStatus.ValueNotSupported	%s	Esta operação não pode ser executada no recurso no estado atual.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.