Todos os produtos
Search
Central de documentação

:DescribeAutoSnapshotPolicyEx

Última atualização: Jul 03, 2026

Consulta as políticas de snapshot automático existentes em uma região.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta também gera dinamicamente códigos de exemplo para diferentes SDKs.

Parâmetros de solicitação

Parâmetro Tipo Obrigatório Exemplo Descrição
Action String Sim DescribeAutoSnapshotPolicyEx

Operação a executar. Defina o valor como DescribeAutoSnapshotPolicyEx.

RegionId String Sim cn-hangzhou

ID da região da política de snapshot automático. Chame a operação DescribeRegions para consultar a lista atual de regiões.

AutoSnapshotPolicyId String Não sp-bp67acfmxazb4ph****

ID da política de snapshot automático.

AutoSnapshotPolicyName String Não TestName

Nome da política de snapshot automático.

PageNumber Integer Não 1

Número da página a retornar.

A numeração começa na página 1.

Valor padrão: 1.

PageSize Integer Não 10

Quantidade de entradas a retornar por página.

Valor máximo: 100.

Valor padrão: 10.

Tag.N.Key String Não TestKey

Chave da tag N da política de snapshot automático. Valores válidos de N: 1 a 20. A chave não pode ser uma string vazia, deve ter até 128 caracteres e não pode começar com acs: ou aliyun. Também não pode conter http:// ou https://.

Tag.N.Value String Não TestValue

Valor da tag N da política de snapshot automático. Valores válidos de N: 1 a 20. O valor pode ser uma string vazia, ter até 128 caracteres e não pode começar com acs: nem conter http:// ou https://.

ResourceGroupId String Não rg-aek2kkmhmhs****

ID do grupo de recursos. Se especificado na consulta, a resposta exibirá até 1.000 recursos pertencentes ao grupo indicado.

Nota Os recursos do grupo de recursos padrão aparecem na resposta independentemente da configuração deste parâmetro.

Parâmetros de resposta

Parâmetro Tipo Exemplo Descrição
PageSize Integer 10

Número de entradas retornadas por página.

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

ID da solicitação.

PageNumber Integer 1

Número da página retornada.

TotalCount Integer 1

Total de políticas de snapshot automático.

AutoSnapshotPolicies Array of AutoSnapshotPolicy

Detalhes das políticas de snapshot automático.

AutoSnapshotPolicy
TimePoints String ["1"]

Horários do dia para criação dos snapshots automáticos.

O horário é exibido em UTC+8. Unidade: horas. Valores válidos: 0 a 23, correspondendo aos 24 horários inteiros de 00:00:00 a 23:00:00. O valor 1 indica 01:00:00. É possível especificar múltiplos horários.

O valor do parâmetro é um array JSON contendo até 24 horários separados por vírgulas (,). Exemplo: ["0", "1", ... "23"].

CreationTime String 2019-12-10T16:00Z

Data e hora de criação da política de snapshot automático. Segue o padrão ISO 8601 no formato yyyy-MM-ddThh:mm:ssZ, exibido em UTC.

Status String Normal

Estado da política de snapshot automático. Valores válidos:

  • Normal: a política de snapshot automático está funcionando normalmente.
  • Expire: a política de snapshot automático não pode ser utilizada devido a pagamentos pendentes na conta.
AutoSnapshotPolicyName String testAutoSnapshotPolicyName

Nome da política de snapshot automático.

TargetCopyRegions String test
Nota Este parâmetro está em visualização restrita e indisponível para usuários gerais.
CopiedSnapshotsRetentionDays Integer 0
Nota Este parâmetro está em visualização restrita e indisponível para usuários gerais.
AutoSnapshotPolicyId String sp-bp67acfmxazb4ph****

ID da política de snapshot automático.

RetentionDays Integer 7

Período de retenção do snapshot automático. Unidade: dias. Valores válidos:

  • -1: o snapshot automático é retido até ser excluído.
  • 1 a 65536: o snapshot automático é retido pelo número especificado de dias.
RegionId String cn-hangzhou

ID da região da política de snapshot automático.

DiskNums Integer 1

Quantidade de discos aos quais a política de snapshot automático se aplica.

EnableCrossRegionCopy Boolean false
Nota Este parâmetro está em visualização restrita e indisponível para usuários gerais.
RepeatWeekdays String ["6"]

Dias da semana para criação dos snapshots automáticos. Valores válidos: 1 a 7, correspondendo aos dias da semana. O valor 1 indica segunda-feira. É possível especificar um ou mais dias.

VolumeNums Integer 2

Quantidade de volumes estendidos aos quais a política de snapshot automático se aplica.

ResourceGroupId String rg-aek2kkmhmhs****

ID do grupo de recursos.

Tags Array of Tag

Tags da política de snapshot automático.

Tag
TagValue String TestValue

Valor da tag da política de snapshot automático.

TagKey String TestKey

Chave da tag da política de snapshot automático.

Exemplos

Solicitações de exemplo

http(s)://ecs.aliyuncs.com/?Action=DescribeAutoSnapshotPolicyEx
&RegionId=cn-hangzhou
&AutoSnapshotPolicyId=sp-bp67acfmxazb4ph****
&AutoSnapshotPolicyName=p-23f2i9s4t
&PageNumber=1
&PageSize=1
&Tag=[{"Key":"TestKey","Value":"TestValue"}]
&ResourceGroupId=rg-aek2kkmhmhs****
&Common request parameters

Respostas de sucesso de exemplo

Formato XML

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

<DescribeAutoSnapshotPolicyExResponse>
    <PageSize>10</PageSize>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <AutoSnapshotPolicies>
        <TimePoints>["1"]</TimePoints>
        <CreationTime>2021-09-01 15:30:01</CreationTime>
        <Status>Normal</Status>
        <AutoSnapshotPolicyName>testAutoSnapshotPolicyName</AutoSnapshotPolicyName>
        <TargetCopyRegions>test</TargetCopyRegions>
        <CopiedSnapshotsRetentionDays>0</CopiedSnapshotsRetentionDays>
        <AutoSnapshotPolicyId>sp-bp67acfmxazb4ph****</AutoSnapshotPolicyId>
        <RetentionDays>7</RetentionDays>
        <RegionId>cn-hangzhou</RegionId>
        <DiskNums>1</DiskNums>
        <EnableCrossRegionCopy>false</EnableCrossRegionCopy>
        <RepeatWeekdays>["6"]</RepeatWeekdays>
        <VolumeNums>2</VolumeNums>
        <ResourceGroupId>rg-aek2kkmhmhs****</ResourceGroupId>
        <Tags>
            <TagValue>TestValue</TagValue>
            <TagKey>TestKey</TagKey>
        </Tags>
    </AutoSnapshotPolicies>
</DescribeAutoSnapshotPolicyExResponse>

Formato JSON

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

{
  "PageSize" : 10,
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber" : 1,
  "TotalCount" : 1,
  "AutoSnapshotPolicies" : [ {
    "TimePoints" : "[\"1\"]",
    "CreationTime" : "2021-09-01 15:30:01",
    "Status" : "Normal",
    "AutoSnapshotPolicyName" : "testAutoSnapshotPolicyName",
    "TargetCopyRegions" : "test",
    "CopiedSnapshotsRetentionDays" : 0,
    "AutoSnapshotPolicyId" : "sp-bp67acfmxazb4ph****",
    "RetentionDays" : 7,
    "RegionId" : "cn-hangzhou",
    "DiskNums" : 1,
    "EnableCrossRegionCopy" : false,
    "RepeatWeekdays" : "[\"6\"]",
    "VolumeNums" : 2,
    "ResourceGroupId" : "rg-aek2kkmhmhs****",
    "Tags" : [ {
      "TagValue" : "TestValue",
      "TagKey" : "TestKey"
    } ]
  } ]
}

Códigos de erro

Código de status HTTP

Códigos de erro

Mensagem de erro

Descrição

400

InvalidRegionId.NotFound

The specified RegionId does not exist.

Mensagem de erro retornada porque o parâmetro RegionId especificado é inválido.

400

InvalidTag.Mismatch

The specified Tag.n.Key and Tag.n.Value are not match.

Mensagem de erro retornada porque o parâmetro Tag.N.Key especificado não corresponde ao parâmetro Tag.N.Value especificado.

400

InvalidTagCount

The specified tags are beyond the permitted range.

Mensagem de erro retornada porque o número de tags especificadas excedeu o limite superior.

Para obter uma lista de códigos de erro, visite o API Error Center.