Tüm Ürünler
Search

Bu Ürün

    :RegisterInstance

    Belge Merkezi

    :RegisterInstance

    Son Güncelleme:Oct 01, 2026

    DMS'de bir veritabanı örneği kaydeder.

    Operation description

    Ön koşullar: Yönetici veya Veritabanı Yöneticisi (DBA) rolüne sahip olmanız gerekir. RoleIdList değerini ListUsers veya GetUser API'sini çağırarak alabilirsiniz.

    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

    dms:RegisterInstance

    create

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Tid

    integer

    No

    Kiracı kimliği. Bu kimliği almak için GetUserActiveTenant işlemini çağırabilirsiniz.

    3***
    InstanceType

    string

    Yes

    Veritabanı türü. Daha fazla bilgi için DbType parametre açıklaması bölümüne bakın.

    MySQL
    InstanceSource

    string

    Yes

    Veritabanı örneğinin kaynağı. Geçerli değerler:

    • PUBLIC_OWN: İnternet üzerinden bağlanan kendi yönettiğiniz bir örnek.

    • RDS: Bir ApsaraDB RDS örneği.

    • ECS_OWN: Elastic Compute Service (ECS) örneği üzerinde dağıtılmış kendi yönettiğiniz bir örnek.

    • VPC_IDC: Sanal Özel Bulut'a (VPC) bağlı bir veri merkezinde bulunan kendi yönettiğiniz bir örnek.

    RDS
    NetworkType

    string

    Yes

    Ağ türü. Geçerli değerler:

    • CLASSIC: Klasik ağ

    • VPC: Sanal Özel Bulut (VPC)

    VPC
    EnvType

    string

    Yes

    Ortam türü. Geçerli değerler:

    • product: Üretim ortamı

    • dev: Geliştirme ortamı

    • pre: Yayın öncesi ortamı

    • test: Test ortamı

    • sit: Sistem entegrasyon testi (SIT) ortamı

    • uat: Kullanıcı kabul testi (UAT) ortamı

    • pet: Performans testi ortamı

    • stag: Hazırlık ortamı

    product
    EcsInstanceId

    string

    No

    ECS örneğinin kimliği.

    Not

    InstanceSource parametresi ECS_OWN olarak ayarlandığında bu parametre gereklidir.

    i-2zei9gs1t7h8l7ac****
    VpcId

    string

    No

    VPC kimliği.

    Not

    InstanceSource parametresi VPC_IDC olarak ayarlandığında bu parametre gereklidir.

    vpc-xxxxxxxxxxxxxxxxxxxxx
    EcsRegion

    string

    No

    Örneğin bulunduğu bölge.

    Not

    InstanceSource parametresi RDS, ECS_OWN veya VPC_IDC olarak ayarlandığında bu parametre gereklidir.

    cn-hangzhou
    Host

    string

    Yes

    Veritabanı örneğinin uç noktası.

    172.XX.XXX.254
    Port

    integer

    Yes

    Veritabanı örneğinin bağlantı noktası.

    3306
    Sid

    string

    No

    Veritabanının sistem kimliği (SID).

    Not

    InstanceType parametresi ORACLE olarak ayarlandığında bu parametre gereklidir.

    XXX
    DatabaseUser

    string

    Yes

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

    dmstest
    DatabasePassword

    string

    Yes

    Veritabanı hesabının parolası.

    ******
    InstanceAlias

    string

    Yes

    Örneği hızlıca tanımlamanıza yardımcı olacak bir diğer ad.

    测试实例
    DbaUid

    integer

    Yes

    Örnek için Veritabanı Yöneticisi (DBA) rolüne sahip kullanıcının UID'si. Bu kimliği almak için ListUsers veya GetInstance işlemini çağırabilirsiniz.

    22275482072787****
    SafeRule

    string

    Yes

    Örnek için Güvenlik Kuralı Kümesinin (GroupName) adı. Bu değeri almak için ListStandardGroups veya GetInstance işlemini çağırabilirsiniz.

    测试使用
    QueryTimeout

    integer

    Yes

    Saniye cinsinden sorgu zaman aşımı süresi.

    60
    ExportTimeout

    integer

    Yes

    Saniye cinsinden dışa aktarma zaman aşımı süresi.

    600
    DataLinkName

    string

    No

    Örnekler arası sorgular için veri bağlantısı adı.

    Not

    • UseDsql parametresi 1 olarak ayarlandığında bu parametre gereklidir.

    • Veri bağlantısı adı yalnızca küçük harfler ve alt çizgiler (_) içerebilir.

    • Veri bağlantısı adı kiracı içinde benzersiz olmalıdır.

    dblink_test
    DdlOnline

    integer

    No

    Kilitsiz şema değişiklikleri için strateji. Geçerli değerler:

    • 0: Devre dışı.

    • 1: Yerel kilitsiz işlemlere öncelik verilir. Bir işlem başarısız olursa, yürütme için Data Management'a (DMS) geri döner.

    • 2: Kilitsiz şema değişiklikleri için Data Management (DMS) kullanılır.

    Not

    Desteklenen veritabanı türleri: ApsaraDB RDS for MySQL, PolarDB for MySQL, ApsaraDB for MyBase (MySQL) ve diğer MySQL uyumlu veritabanları.

    2
    UseDsql

    integer

    No

    Örnekler arası sorguların etkinleştirilip etkinleştirilmeyeceğini belirtir. Geçerli değerler:

    • 0: Devre dışı

    • 1: Etkin

    Not

    Desteklenen veritabanı türleri: MySQL, SQL Server, PostgreSQL, PolarDB for PostgreSQL (Oracle uyumlu) ve Redis.

    1
    SkipTest

    boolean

    No

    Bağlantı testinin atlanıp atlanmayacağını belirtir. Geçerli değerler:

    • true: Testi atlar.

    • false: Testi gerçekleştirir.

    true
    EnableSellSitd

    string

    No

    • Y: Hassas veri korumasını etkinleştirir.

    • NULL veya diğer değerler: Hassas veri korumasını devre dışı bırakır.

    Y
    TemplateId

    integer

    No

    Hassasiyet sınıflandırma şablonunun kimliği. Bu kimliği almak için ListClassificationTemplates işlemini çağırabilirsiniz.

    31***
    TemplateType

    string

    No

    Hassasiyet sınıflandırma şablonunun türü. Bu değeri almak için ListClassificationTemplates işlemini çağırabilirsiniz.

    INNER
    DbaUidByString

    string

    No

    Bu parametre DbaUid parametresinin yerini alır ve RAM rollerinin UID'leri gibi sayısal olmayan UID'leri destekler.

    22275482072787****
    ResourceGroup

    string

    No

    Kaynak grubunun kimliği.

    Response elements

    Element

    Type

    Description

    Example

    object

    Yanıt verileri.

    RequestId

    string

    İsteğin kimliği.

    F4E2A94B-604F-43FF-93E7-F4EE3DCF412E
    ErrorCode

    string

    İstek başarısız olursa döndürülen hata kodu.

    UnknownError
    ErrorMessage

    string

    İstek başarısız olursa döndürülen hata mesajı.

    UnknownError
    Success

    boolean

    İsteğin başarılı olup olmadığını gösterir. Geçerli değerler:

    • true: İstek başarılı oldu.

    • false: İstek başarısız oldu.

    true

    Examples

    Success response

    JSON format

    {
  "RequestId": "F4E2A94B-604F-43FF-93E7-F4EE3DCF412E",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.