Cria uma política de snapshot automático em uma região especificada. Você pode especificar o ciclo de repetição, o período de retenção e as configurações de backup entre regiões para criar backups de snapshot para discos em nuvem do sistema ou discos em nuvem de dados.
Descrição da operação
Antes de chamar esta operação, leia atentamente Criar uma política de snapshot automático.
Ao chamar esta operação, observe os seguintes itens:
-
Uma conta Alibaba Cloud pode criar até 100 políticas de snapshot automático em uma região. Se o número de snapshots automáticos para um disco em nuvem atingir o limite de cota, o sistema exclui o snapshot automático mais antigo gerado pela política de snapshot automático ao criar uma nova tarefa de snapshot.
-
O sistema não executa a política de snapshot automático quando uma instância ECS tem uma tarefa de parada ou reinicialização.
-
Se a replicação de snapshot entre regiões estiver ativada e nenhum parâmetro de criptografia estiver configurado, os snapshots criptografados serão criptografados e copiados usando a chave de serviço de destino por padrão. Para obter precauções sobre a replicação de snapshot entre regiões, consulte Copiar um snapshot.
Após criar uma política de snapshot automático, você deve chamar ApplyAutoSnapshotPolicy para aplicar a política aos discos em nuvem de destino. Para modificar a política de snapshot automático, chame ModifyAutoSnapshotPolicyEx.
Experimente agora
Testar
Autorização RAM
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| regionId |
string |
Sim |
A região à qual a política de snapshot automático pertence. Você pode chamar DescribeRegions para consultar a lista de regiões mais recente. |
cn-hangzhou |
| autoSnapshotPolicyName |
string |
Não |
O nome da política de snapshot automático. O nome deve ter de 2 a 128 caracteres e deve começar com uma letra ou um caractere chinês. Não pode começar com http:// ou https://. Pode conter dígitos, dois-pontos (:), sublinhados (_) e hifens (-). Valor padrão: null. |
TestName |
| timePoints |
string |
Sim |
Os horários em que os snapshots automáticos são criados. O horário está em UTC+8 e é medido em horas. Valores válidos: 0 a 23, que representam 24 horários de 00:00 às 23:00. Por exemplo, 1 indica 01:00. Descrição do formato:
Nota
Se o disco em nuvem contiver uma grande quantidade de dados e o tempo necessário para criar um único snapshot automático exceder o intervalo entre dois horários, o sistema pulará o próximo horário. Por exemplo, se você definir 09:00, 10:00, 11:00 e 12:00 como os horários para snapshots automáticos, e a criação do snapshot começar às 09:00 e terminar às 10:20, levando 80 minutos, o sistema pulará as 10:00 e criará o próximo snapshot automático às 11:00. |
["0", "1", … "23"] |
| repeatWeekdays |
string |
Sim |
Os dias da semana em que os snapshots automáticos são criados. A unidade é dias e o ciclo é semanas. Valores válidos: 1 a 7. Por exemplo, 1 indica segunda-feira. Descrição do formato:
|
["1","2"] |
| retentionDays |
integer |
Sim |
O período de retenção dos snapshots automáticos. Unidade: dias. Valores válidos:
Valor padrão: -1. |
30 |
| EnableCrossRegionCopy |
boolean |
Não |
Especifica se a replicação automática entre regiões deve ser ativada. Valores válidos:
|
false |
| TargetCopyRegions |
string |
Não |
A região de destino para a replicação de snapshot entre regiões. Você pode especificar apenas uma região de destino. |
["cn-hangzhou"] |
| StorageLocationArn |
string |
Não |
Nota
Este parâmetro não está disponível. |
null |
| CopiedSnapshotsRetentionDays |
integer |
Não |
O período de retenção dos snapshots replicados entre regiões. Unidade: dias. Valores válidos:
Valor padrão: -1. |
30 |
| CopyEncryptionConfiguration |
object |
Não |
Os parâmetros de criptografia de backup para georredudância de snapshot. |
|
| Arn |
array<object> |
Não |
Nota
Este parâmetro não está disponível. |
|
|
object |
Não |
|||
| AssumeRoleFor |
integer |
Não |
Nota
Este parâmetro não está disponível. |
1000000000 |
| RoleType |
string |
Não |
Nota
Este parâmetro não está disponível. |
hide |
| Rolearn |
string |
Não |
Nota
Este parâmetro não está disponível. |
hide |
| Encrypted |
boolean |
Não |
Especifica se a criptografia para backups de snapshot entre regiões deve ser ativada. Valores válidos:
Valor padrão: false. |
false |
| KMSKeyId |
string |
Não |
O ID da chave KMS usado para a criptografia de backup de georredudância de snapshot. |
0e478b7a-4262-4802-b8cb-00d3fb40826X |
| ResourceGroupId |
string |
Não |
O ID do grupo de recursos. |
rg-aek2kkmhmhs**** |
| Tag |
array<object> |
Não |
A lista de tags para a política de snapshot automático. |
|
|
object |
Não |
|||
| Key |
string |
Não |
A chave da tag da política de snapshot automático. Valores válidos de N: 1 a 20. Se você especificar este parâmetro, ele não poderá ser uma string vazia. A chave da tag pode ter até 128 caracteres. Não pode começar com aliyun ou acs: e 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. Se você especificar este parâmetro, ele poderá ser uma string vazia. O valor da tag pode ter até 128 caracteres. Não pode começar com acs: e não pode conter http:// ou https://. |
TestValue |
| AssociationType |
string |
Não |
O tipo de associação entre a política de snapshot automático e os recursos de destino. Valores válidos:
Valor padrão: AssociatedWithDisk. |
AssociatedWithDisk |
| TargetTags |
array<object> |
Não |
A lista de tags de recursos de destino. A política de snapshot automático corresponde aos recursos de destino com base nas tags. Este parâmetro é obrigatório quando AssociationType é definido como AssociatedWithInstanceTag. |
|
|
object |
Não |
A tag do recurso de destino. |
||
| Key |
string |
Não |
A chave da tag. Valores válidos de N: 1 a 5. Se você especificar este parâmetro, ele não poderá ser uma string vazia. A chave da tag pode ter até 128 caracteres. Não pode começar com aliyun ou acs: e não pode conter http:// ou https://. |
TestKey |
| Value |
string |
Não |
O valor da tag. Valores válidos de N: 1 a 5. O valor da tag pode ter até 128 caracteres e não pode conter http:// ou https://. Nota
Se você deixar este parâmetro vazio ou especificar uma string vazia, isso indica qualquer valor. |
TestValue |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
|||
| AutoSnapshotPolicyId |
string |
O ID da política de snapshot automático. |
sp-bp12m37ccmxvbmi5**** |
| RequestId |
string |
O ID da solicitação. |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
Exemplos
Resposta de sucesso
JSON formato
{
"AutoSnapshotPolicyId": "sp-bp12m37ccmxvbmi5****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}
Códigos de erro
|
Código de status HTTP |
Código de erro |
Mensagem de erro |
Descrição |
|---|---|---|---|
| 400 | DiskCategory.OperationNotSupported | The type of the specified disk does not support creating a snapshot. | O tipo de disco atual não oferece suporte a esta operação. |
| 400 | InvalidSnapshotPolicyName.Malformed | The specified autoSnapshotPolicyName is malformed. | |
| 400 | Duplicate.TagKey | The parameter Tag.N.Key contains duplicate values. Please remove the duplicate tag keys and try again. | |
| 400 | InvalidTagKey.Malformed | The specified Tag.n.Key is not valid. | O parâmetro de chave de tag especificado é inválido. |
| 400 | InvalidTagValue.Malformed | The specified Tag.n.Value is not valid. | O parâmetro de valor da tag especificado é inválido. |
| 400 | InvalidParameter.EncryptedIllegal | The Encrypted parameter must be set to true when KMSKeyId is specified. Please adjust the parameters and try again. | |
| 400 | InvalidParameter.KmsNotEnabled | The operation failed because KMS is not activated. Please activate KMS in the KMS console and try again. | |
| 400 | InvalidParameter.Encrypted.KmsNotEnable | The operation failed because KMS is not activated. Please activate KMS in the KMS console and try again. | |
| 400 | InvalidParam.EncryptedMismatch | Creating a disk from a shared encrypted image requires encryption with your own KMS key. Please set the Encrypted parameter to true. | |
| 400 | InvalidAssociationType.Malformed | The specified parameter AssociationType is invalid. Please check the valid range for this parameter. | |
| 400 | MissingParameter.TargetTags | When the parameter AssociationType is set to AssociatedWithInstanceTag, the TargetTags parameter is required. | |
| 400 | InvalidTargetTags.NotSupported | The TargetTags parameter is not supported when AssociationType is set to AssociatedWithDisk. Please remove TargetTags and try again. | |
| 400 | InvalidTargetTagKey.Malformed | The specified TargetTag.n.Key [%s] is not valid. | |
| 400 | InvalidTargetTagValue.Malformed | The specified TargetTag.n.Value [%s] is not valid. | |
| 400 | Duplicate.TargetTagKey | Duplicate keys exist in the specified parameter TargetTags. Please ensure key uniqueness. | |
| 400 | InvalidTargetTag.LimitExceed | The number [%s] of the specified parameter TargetTag exceeds the limit [%s]. | |
| 403 | ParameterInvalid | The specified RegionId parameter is invalid. | A política de snapshot automático especificada não existe. Verifique se a política de snapshot automático está correta. |
| 403 | AutoSnapshotPolicy.QuotaExceed | The maximum number of automatic snapshot policy has been reached. | |
| 403 | InvalidAccountStatus.NotEnoughBalance | Your account does not have enough balance. | |
| 403 | InvalidAccountStatus.SnapshotServiceUnavailable | The snapshot service has not been activated. Please activate it and try again. | |
| 403 | InvalidParameter.TargetCopyRegions | The specified TargetCopyRegions is invalid. | |
| 403 | InvalidParameter.CopiedSnapshotsRetentionDays | The specified CopiedSnapshotsRetentionDays is invalid. | |
| 403 | InvalidParameter.KMSKeyId.KMSUnauthorized | ECS service does not have permission to access your KMS key. Please verify that the specified KMS key has authorized the ECS service. | |
| 403 | InvalidOperation.KMSKeyIdNotFound | The specified KMSKeyId does not exist. Please verify that the key ID is correct and that the key resides in the current region. | |
| 403 | Abs.InvalidAction.RegionNotSupport | The current operation is not supported in the specified region. Please switch to a supported region and try again. | |
| 403 | InvalidParameter.KMSKeyId.CMKNotEnabled | The specified KMS key must be in an enabled state. Please enable the key in the KMS console and try again. | |
| 403 | InvalidParameter.KMSKeyId.CMKUnauthorized | The specified KMS key is not authorized for the ECS service. Please grant the ECS service permission to use the key in the KMS console and try again. | |
| 403 | InvalidStorageLocationArn.Malformed | The specified parameter StorageLocationArn is malformed. | |
| 403 | InvalidOperation.UserNotInWhiteList | The current user is temporarily unable to use this feature. Please submit a ticket for assistance. | |
| 403 | InvalidOperation.CopyingDataToThisRegionUnsupported | Data transfer to the current region from other regions is not supported. | Os dados podem ser replicados para a região atual apenas a partir de regiões específicas. |
| 404 | InvalidResourceGroup.NotFound | The ResourceGroup provided does not exist in our records. | O grupo de recursos especificado não existe. |
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.