Tüm Ürünler
Search

Bu Ürün

    :GetInstance

    Belge Merkezi

    :GetInstance

    Son Güncelleme:Oct 01, 2026

    Belirtilen bir örneğin ayrıntılarını getirir.

    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:GetInstance

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Tid

    integer

    No

    Kiracı kimliği. Bu değeri almak için GetUserActiveTenant işlemini çağırın.

    2***
    Host

    string

    Yes

    Örneğin uç noktası. Bu değeri almak için ListInstances işlemini çağırın.

    172.17.XXX.XXX
    Port

    integer

    Yes

    Örneğin bağlantı noktası. Bu değeri almak için ListInstances işlemini çağırın.

    5432
    Sid

    string

    No

    Örneğin SID'si. Bu değeri almak için ListInstances işlemini çağırın.

    test
    RealLoginUserUid

    string

    No

    Bu parametre ayrılmıştır.

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    İstek kimliği.

    F6C80B69-3203-56AC-8021-18BA72A6F4E1
    Instance

    object

    Örnekle ilgili ayrıntılar.

    VpcId

    string

    Örneğin ait olduğu VPC'nin kimliği.

    vpc-o6wrloqsdqc9io3mg****
    DatabaseUser

    string

    Örnekte oturum açmak için kullanılan kullanıcı adı.

    dbuser
    DbaId

    string

    Örneğin veritabanı yöneticisinin (DBA) kimliği.

    29****
    UseDsql

    integer

    Örnek için veritabanları arası sorgulamanın etkinleştirilip etkinleştirilmediğini gösterir. Geçerli değerler:

    • 0: devre dışı

    • 1: etkin

    0
    Port

    integer

    Örneğe bağlanmak için kullanılan bağlantı noktası.

    5432
    EcsInstanceId

    string

    Veritabanı örneğinin dağıtıldığı ECS örneğinin kimliği.

    i-bp124ldpklqz59y3****
    EnvType

    string

    Örneğin ait olduğu ortamın türü. Geçerli değerler:

    • product: üretim ortamı

    • dev: geliştirme ortamı

    • pre: ön sürüm 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ı

    test
    Sid

    string

    Örneğin sistem kimliği (SID).

    test
    OwnerIdList

    object

    Örnek sahiplerinin kimlikleri.

    OwnerIds

    array

    Örnek sahiplerinin kullanıcı kimlikleri.

    string

    Bir örnek sahibinin kullanıcı kimliği.

    10****
    SafeRuleId

    string

    Örnek için güvenlik kuralı kümesinin kimliği.

    3****
    OwnerNameList

    object

    Örnek sahiplerinin takma adları.

    OwnerNames

    array

    Örnek sahiplerinin takma adları.

    string

    Bir örnek sahibinin takma adı.

    yang_test
    DbaNickName

    string

    Örneğin veritabanı yöneticisinin takma adı.

    dbaname
    QueryTimeout

    integer

    Örnekteki verileri sorgulamak için zaman aşımı süresi. Birim: saniye.

    7200
    InstanceSource

    string

    Örneğin kaynağı.

    ECS_OWN
    Host

    string

    Örneğe bağlanmak için kullanılan uç nokta.

    192.168.XXX.XXX
    State

    string

    Örneğin durumu. Geçerli değerler:

    • NORMAL: Örnek normal şekilde çalışıyor.

    • DISABLE: Örnek devre dışı.

    NORMAL
    DataLinkName

    string

    Örnek için veri bağlantısının adı.

    test
    ExportTimeout

    integer

    Örnekten veri dışa aktarmak için zaman aşımı süresi. Birim: saniye.

    86400
    InstanceId

    string

    Örneğin kimliği.

    188****
    InstanceType

    string

    Veritabanının türü.

    postgresql
    DatabasePassword

    string

    Kullanıcı adına karşılık gelen parola.

    ******
    InstanceAlias

    string

    Örneğin diğer adı.

    测试
    DdlOnline

    integer

    Örnek için kilitsiz şema değişikliğinin etkinleştirilip etkinleştirilmediğini gösterir.

    0
    EcsRegion

    string

    Örneğin bulunduğu bölge.

    cn-beijing
    StandardGroup

    object

    Örneğin kontrol modu.

    GroupName

    string

    Kontrol moduna karşılık gelen güvenlik kuralı kümesinin adı.

    自由操作
    GroupMode

    string

    Kontrol modu. Geçerli değerler:

    • COMMON: Güvenlik İş Birliği

    • NONE_CONTROL: Esnek Yönetim

    • STABLE: Kararlı Değişiklik

    NONE_CONTROL
    SellSitd

    string

    Hassas veri korumasının etkinleştirilip etkinleştirilmediğini gösterir. Geçerli değerler:

    • true: etkin

    • false: devre dışı

    false
    SellTrust

    string

    Bu parametre ayrılmıştır.

    ErrorCode

    string

    Döndürülen hata kodu.

    UnknownError
    ErrorMessage

    string

    Döndürülen hata mesajı.

    UnknownError
    Success

    boolean

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

    • true

    • false

    true

    Examples

    Success response

    JSON format

    {
  "RequestId": "F6C80B69-3203-56AC-8021-18BA72A6F4E1",
  "Instance": {
    "VpcId": "vpc-o6wrloqsdqc9io3mg****",
    "DatabaseUser": "dbuser",
    "DbaId": "29****",
    "UseDsql": 0,
    "Port": 5432,
    "EcsInstanceId": "i-bp124ldpklqz59y3****",
    "EnvType": "test",
    "Sid": "test",
    "OwnerIdList": {
      "OwnerIds": [
        "10****"
      ]
    },
    "SafeRuleId": "3****",
    "OwnerNameList": {
      "OwnerNames": [
        "yang_test"
      ]
    },
    "DbaNickName": "dbaname",
    "QueryTimeout": 7200,
    "InstanceSource": "ECS_OWN",
    "Host": "192.168.XXX.XXX",
    "State": "NORMAL",
    "DataLinkName": "test",
    "ExportTimeout": 86400,
    "InstanceId": "188****",
    "InstanceType": "postgresql",
    "DatabasePassword": "******",
    "InstanceAlias": "Test",
    "DdlOnline": 0,
    "EcsRegion": "cn-beijing",
    "StandardGroup": {
      "GroupName": "Free operation",
      "GroupMode": "NONE_CONTROL"
    },
    "SellSitd": "false",
    "SellTrust": ""
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.