All Products
Search
Document Center

Data Management:GetInstance

Last Updated:Jun 11, 2026

Mengkueri detail sebuah instance.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

  • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

  • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

  • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

  • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

    • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

    • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

  • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

  • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

dms:GetInstance

get

*全部资源

*

None None

Parameter permintaan

Parameter

Type

Required

Description

Example

Tid

integer

No

ID tenant. Anda dapat memanggil operasi GetUserActiveTenant untuk mendapatkan nilai parameter ini.

2***

Host

string

Yes

Endpoint instance. Anda dapat memanggil operasi ListInstances untuk mendapatkan nilai parameter ini.

172.17.XXX.XXX

Port

integer

Yes

Port yang digunakan untuk terhubung ke instance. Anda dapat memanggil operasi ListInstances untuk mendapatkan nilai parameter ini.

5432

Sid

string

No

SID instance. Anda dapat memanggil operasi ListInstances untuk mendapatkan nilai parameter ini.

test

RealLoginUserUid

string

No

Elemen respons

Element

Type

Description

Example

object

RequestId

string

ID permintaan.

F6C80B69-3203-56AC-8021-18BA72A6F4E1

Instance

object

Detail instance.

VpcId

string

ID virtual private cloud (VPC) tempat instance berada.

vpc-o6wrloqsdqc9io3mg****

DatabaseUser

string

Nama pengguna yang digunakan untuk masuk ke instance.

dbuser

DbaId

string

ID database administrator (DBA) instance.

29****

UseDsql

integer

Menunjukkan apakah kueri lintas-database diaktifkan untuk instance. Nilai yang valid:

  • 0: dinonaktifkan

  • 1: diaktifkan

0

Port

integer

Port yang digunakan untuk terhubung ke instance.

5432

EcsInstanceId

string

ID instance Elastic Compute Service (ECS) tempat instance database di-deploy.

i-bp124ldpklqz59y3****

EnvType

string

Jenis lingkungan tempat instance berada. Nilai yang valid:

  • product: lingkungan produksi

  • dev: lingkungan pengembangan

  • pre: lingkungan pre-release

  • test: lingkungan pengujian

  • sit: lingkungan system integration testing (SIT)

  • uat: lingkungan user acceptance testing (UAT)

  • pet: lingkungan stress testing

  • stag: lingkungan staging (STAG)

test

Sid

string

SID instance.

test

OwnerIdList

object

OwnerIds

array

The IDs of the owners for the database instance.

string

The ID of the instance Owner.

10****

SafeRuleId

string

ID aturan keamanan untuk instance.

3****

OwnerNameList

object

OwnerNames

array

The nicknames of the owners for the database instance.

string

The nickname of the instance Owner.

yang_test

DbaNickName

string

Nickname DBA instance.

dbaname

QueryTimeout

integer

Periode timeout kueri instance. Satuan: detik.

7200

InstanceSource

string

Sumber instance.

ECS_OWN

Host

string

Endpoint instance.

192.168.XXX.XXX

State

string

Status instance. Nilai yang valid:

  • NORMAL: Instance sedang digunakan.

  • DISABLE: Instance dinonaktifkan.

NORMAL

DataLinkName

string

Nama DataLink untuk instance.

test

ExportTimeout

integer

Periode timeout ekspor instance. Satuan: detik.

86400

InstanceId

string

ID instance.

188****

InstanceType

string

Jenis database instance.

postgresql

DatabasePassword

string

Kata sandi pengguna database.

******

InstanceAlias

string

Alias instance.

测试

DdlOnline

integer

Konfigurasi DdlOnline instance.

0

EcsRegion

string

Region tempat instance berada.

cn-beijing

StandardGroup

object

Informasi mode kontrol instance.

GroupName

string

The name of the security rule set corresponding to the control mode.

自由操作

GroupMode

string

The type of the control mode. Valid values:

  • COMMON: Security Collaboration

  • NONE_CONTROL: Flexible Management

  • STABLE: Stable Change

NONE_CONTROL

SellSitd

string

Menunjukkan apakah perlindungan data sensitif diaktifkan. Nilai yang valid:

  • true: diaktifkan

  • false: dinonaktifkan

false

SellTrust

string

ErrorCode

string

Kode kesalahan.

UnknownError

ErrorMessage

string

Pesan kesalahan.

UnknownError

Success

boolean

Menunjukkan apakah permintaan berhasil. Nilai yang valid:

  • true: Permintaan berhasil.

  • false: Permintaan gagal.

true

Contoh

Respons sukses

JSONformat

{
  "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": "测试",
    "DdlOnline": 0,
    "EcsRegion": "cn-beijing",
    "StandardGroup": {
      "GroupName": "自由操作",
      "GroupMode": "NONE_CONTROL"
    },
    "SellSitd": "false",
    "SellTrust": ""
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.