Tüm Ürünler
Search

Bu Ürün

    :CreateRestoreTask

    Belge Merkezi

    :CreateRestoreTask

    Son Güncelleme:Oct 12, 2026

    Bir Veritabanı Yedekleme (DBS) geri yükleme görevi oluşturur.

    Operation description

    İlgili işlemler

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    dbs:CreateRestoreTask

    create

    *Tüm kaynaklar.

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    BackupPlanId

    string

    Yes

    Yedekleme planının kimliği.

    dbs1hvb0ww****
    DestinationEndpointInstanceType

    string

    Yes

    Veritabanının konumu. Geçerli değerler:

    • RDS

    • ECS

    • Express: Express Connect devreleri, VPN ağ geçitleri veya Smart Access Gateway (SAG) üzerinden bağlanan veritabanları

    • Agent: Yedekleme ağ geçitleri üzerinden bağlanan veritabanları

    • DDS: ApsaraDB for MongoDB

    • Other: IP adresleri ve bağlantı noktası numaraları kullanılarak bağlanan veritabanları

    • dg: Genel IP adresleri veya bağlantı noktası numaraları olmayan ve Veritabanı Ağ Geçidi üzerinden bağlanan kendi yönettiğiniz veritabanları

    RDS
    DestinationEndpointRegion

    string

    No

    Veritabanı örneğinin bölgesi.

    Not

    Bu parametre, DestinationEndpointInstanceType RDS, ECS, DDS, Express veya Agent olarak ayarlandığında gereklidir.

    cn-hangzhou
    DestinationEndpointInstanceID

    string

    No

    Veritabanının örnek kimliği.

    Not

    Bu parametre, DestinationEndpointInstanceType RDS, ECS, DDS veya Express olarak ayarlandığında gereklidir.

    rm-bp1p8c29*****
    DestinationEndpointIP

    string

    No

    Veritabanı bağlantı adresi.

    Not

    Bu parametre, DestinationEndpointInstanceType Express, Agent veya Other olarak ayarlandığında gereklidir.

    rm-bp*****9jv8pxero.mysql.rds.aliyuncs.com
    DestinationEndpointPort

    integer

    No

    Veritabanının bağlantı noktası numarası.

    Not

    Bu parametre, DestinationEndpointInstanceType Express, Agent, Other veya ECS olarak ayarlandığında gereklidir.

    3306
    DestinationEndpointDatabaseName

    string

    No

    Veritabanının adı.

    Not

    Bu parametre, veritabanı motoru PostgreSQL veya MongoDB olduğunda gereklidir.

    test
    DestinationEndpointUserName

    string

    No

    Veritabanı hesabının kullanıcı adı.

    Not

    Bu parametre, veritabanı motoru Redis olduğunda veya veritabanı bir yedekleme ağ geçidi üzerinden bağlanıyorsa ve veritabanı motoru SQL Server olduğunda gerekli değildir. Diğer senaryolarda bu parametre gereklidir.

    test
    DestinationEndpointPassword

    string

    No

    Veritabanı hesabının parolası.

    Not

    Bu parametre, veritabanı motoru Redis olduğunda veya veritabanı bir yedekleme ağ geçidi üzerinden bağlanıyorsa ve veritabanı motoru SQL Server olduğunda gerekli değildir. Diğer senaryolarda bu parametre gereklidir.

    Test
    BackupGatewayId

    integer

    No

    Yedekleme ağ geçidinin kimliği.

    Not

    Bu parametre, DestinationEndpointInstanceType Agent olarak ayarlandığında gereklidir.

    4312****
    RestoreObjects

    string

    No

    Geri yüklenecek nesneler.

    • Daha fazla bilgi için aşağıdaki RestoreObjects parametresinin tanımına bakın. Bu parametre, veritabanı bir yedekleme ağ geçidi üzerinden bağlandığında gerekli değildir. Diğer senaryolarda bu parametre gereklidir.

    • Şablon: [{ "DBName": "Geri yüklenecek veritabanının adı", "NewDBName": "Hedef veritabanının adı" }]

    Not

    Bu API işlemini çağırarak nesneleri geri yükleme, yalnızca veritabanı düzeyinde geri yüklemeyi destekler. Belirli tabloları geri yüklemek için konsola gidin. Daha fazla bilgi için Veritabanını geri yükleme konusuna bakın.

    Example of MySQL table-level restoration: [{\"DBName\":\"dbname\", \"NewDBName\":\"dbname1\"}]
    RestoreTime

    integer

    No

    Veritabanını geri yüklemek istediğiniz zaman noktası. Değer, milisaniye cinsinden bir UNIX zaman damgasıdır.

    1554560477000
    BackupSetId

    string

    No

    Geri yükleme için kullanılan tam yedekleme kümesinin kimliği. Bu parametre ile RestoreTime birbirini dışlar.

    dbs1hvb0w*****
    RestoreTaskName

    string

    Yes

    Geri yükleme görevinin adı.

    test
    DestinationEndpointOracleSID

    string

    No

    Oracle SID'si.

    Not

    Bu parametre, veritabanı motoru Oracle olduğunda gereklidir.

    test
    RestoreDir

    string

    No

    Bu parametre, DestinationEndpointInstanceType Agent olarak ayarlandığında ve yedekleme planı MySQL için olduğunda gereklidir.

    test
    RestoreHome

    string

    No

    Veritabanı programının dizini.

    test
    DuplicateConflict

    string

    No

    Aynı ada sahip nesneler arasındaki çakışmaları işlemek için kullanılan yöntem. Geçerli değerler:

    • renamenew: Aynı ada sahip bir nesne varsa nesneyi yeniden adlandırır.

    renamenew
    CrossAliyunId

    string

    No

    Hesaplar arası yedekleme için kullanılan Alibaba Cloud hesabının UID'si.

    2749528728********
    CrossRoleName

    string

    No

    Hesaplar arası yedekleme için kullanılan RAM rolünün adı.

    test123
    ClientToken

    string

    No

    İsteğin idempotent olmasını sağlamak ve yinelenen gönderimleri önlemek için kullanılan istemci belirteci.

    ETnLKlblzczshOTUbOC********
    RestoreDestinationMode

    string

    No

    Verileri hedefe geri yüklemek için kullanılan yöntem. Geçerli değerler:

    • EXIST_INSTANCE: Verileri mevcut bir örneğe geri yükler.

    • NEW_INSTANCE: Verileri yeni bir örneğe geri yükler.

    EXIST_INSTANCE
    EnableDestinationEndpointSsl

    boolean

    No

    Hedefe SSL şifreli bağlantı kullanılarak bağlanılıp bağlanılmayacağını belirtir.

    true
    SslCaPem

    string

    No

    Hedefe SSL şifreli bağlantı için kullanılan kimlik bilgisi.

    -----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----
    DestDatabaseInstanceType

    string

    No

    Verilerin geri yüklendiği yeni veritabanının örnek türü.

    rds
    DestDatabaseInstanceRegion

    string

    No

    Verilerin geri yüklendiği yeni veritabanı örneğinin bölgesi.

    cn-beijing
    DestDatabaseInstanceVpc

    string

    No

    Verilerin geri yüklendiği yeni veritabanı örneğinin VPC'si.

    vpc-xx
    DestDatabaseInstanceClass

    string

    No

    Verilerin geri yüklendiği yeni veritabanı örneğinin teknik özellikleri.

    mysql.x4.large.2
    DestDatabaseInstanceStorageSize

    string

    No

    Verilerin geri yüklendiği yeni veritabanının depolama boyutu.

    500
    DestDatabaseInstanceVSwitch

    string

    No

    Verilerin geri yüklendiği yeni veritabanı örneğinin vSwitch'i.

    vsw-xx
    DestDatabaseInstanceDatabaseVersion

    string

    No

    Verilerin geri yüklendiği yeni veritabanı örneğinin veritabanı motoru sürümü.

    8.0
    AutoOpenDatabase

    string

    No

    Bir Oracle fiziksel yedeklemesi geri yüklendikten sonra örneğin otomatik olarak başlatılıp başlatılmayacağını belirtir.

    true
    AutoShutdownDatabase

    string

    No

    Bir Oracle fiziksel yedeklemesi geri yüklendikten sonra örneğin otomatik olarak kapatılıp kapatılmayacağını belirtir.

    true

    Response elements

    Element

    Type

    Description

    Example

    object

    Yanıt parametrelerinin ayrıntıları.

    HttpStatusCode

    integer

    HTTP durum kodu.

    200
    RequestId

    string

    İsteğin kimliği.

    60AF7C5D-EF4D-4D48-8FD5-C0823FDF28AC
    ErrCode

    string

    Hata kodu.

    Param.NotFound
    Success

    boolean

    İsteğin başarılı olup olmadığını gösterir.

    true
    ErrMessage

    string

    Hata mesajı.

    The specified parameter %s value is not valid.

    RestoreTaskId

    string

    Geri yükleme görevinin kimliği.

    s102h*****

    Examples

    Success response

    JSON format

    {
  "HttpStatusCode": 200,
  "RequestId": "60AF7C5D-EF4D-4D48-8FD5-C0823FDF28AC",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.  ",
  "RestoreTaskId": "s102h*****"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    403 Request.Forbidden Have no Permissions

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.