Ringkasan API GetDBTopology untuk Topologi Database Logis - Data Management - Alibaba Cloud - Data Management

Mendapatkan informasi topologi basis data logis dan basis data fisik shard yang terkait.

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

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
LogicDbId	integer	Yes	ID basis data logis. Catatan Anda dapat memanggil operasi ListLogicDatabases untuk mendapatkan nilai parameter ini.	134325
Tid	integer	No	ID tenant. Catatan Anda dapat mengarahkan kursor ke gambar profil di sudut kanan atas sistem untuk melihat ID tenant. Untuk informasi lebih lanjut, lihat Lihat informasi tenant.	43215

Elemen respons

Element	Type	Description	Example
	object	Skema Respons
RequestId	string	ID permintaan.	C5B8E84B-42B6-4374-AD5A-6264E1753378
Success	boolean	Menunjukkan apakah permintaan berhasil.	true
ErrorMessage	string	Pesan kesalahan.	UnknownError
ErrorCode	string	Kode kesalahan.	UnknownError
DBTopology	object	Informasi topologi.
LogicDbId	integer	ID basis data logis.	1234
LogicDbName	string	Nama basis data logis.	logic_db_test
SearchName	string	Nama pencarian basis data logis.	logic_db_test
Alias	string	Alias basis data logis.	logic_db_test
DbType	string	Tipe basis data. Untuk informasi lebih lanjut tentang nilai yang valid untuk parameter ini, lihat Parameter DbType.	polardb
EnvType	string	Tipe lingkungan basis data logis. Nilai yang valid: product: lingkungan produksi dev: lingkungan pengembangan pre: lingkungan pra-rilis test: lingkungan pengujian sit: lingkungan pengujian integrasi sistem (SIT) uat: lingkungan pengujian penerimaan pengguna (UAT) pet: lingkungan pengujian tekanan stag: lingkungan staging (STAG) Catatan Untuk informasi lebih lanjut, lihat Lingkungan instance.	dev
DBTopologyInfoList	array<object>	Daftar informasi topologi basis data shard.
	object	Informasi topologi basis data shard.
DbId	integer	The ID of the database for which the schema design is executed.	423532
SchemaName	string	The name of the logical database. Catatan If the database is a PostgreSQL database, the value of this parameter is the name of the database schema.	db_test@rm-xxx:3306
CatalogName	string	The name of the catalog to which the database belongs. Catatan If the database is a PostgreSQL database, the value of this parameter is the name of the database.	def
SearchName	string	The name of the saved search.	db_test
DbType	string	The type of the database engine.	polardb
EnvType	string	The type of the environment to which the database belongs. Valid values: product: production environment dev: development environment pre: staging environment test: test environment sit: SIT environment uat: user acceptance testing (UAT) environment pet: stress testing environment stag: STAG environment	dev
InstanceId	integer	The ID of the instance. The valid value is returned if you call the ListInstances operation. The instance ID is not the ID of the RDS instance.	4325325
RegionId	string	The ID of the region in which the instance resides.	cn-hangzhou
InstanceResourceId	string	Instance resource ID.	rm-xxx
InstanceSource	string	The source of the database instance. Valid values: PUBLIC_OWN: a self-managed database instance that is deployed on the Internet RDS: an ApsaraDB RDS instance ECS_OWN: a self-managed database that is deployed on an Elastic Compute Service (ECS) instance VPC_IDC: a self-managed database instance that is deployed in a data center connected over a virtual private cloud (VPC)	RDS

Contoh

Respons sukses

JSONformat

{
  "RequestId": "C5B8E84B-42B6-4374-AD5A-6264E1753378",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "DBTopology": {
    "LogicDbId": 1234,
    "LogicDbName": "logic_db_test",
    "SearchName": "logic_db_test",
    "Alias": "logic_db_test",
    "DbType": "polardb",
    "EnvType": "dev",
    "DBTopologyInfoList": [
      {
        "DbId": 423532,
        "SchemaName": "db_test@rm-xxx:3306",
        "CatalogName": "def",
        "SearchName": "db_test",
        "DbType": "polardb",
        "EnvType": "dev",
        "InstanceId": 4325325,
        "RegionId": "cn-hangzhou",
        "InstanceResourceId": "rm-xxx",
        "InstanceSource": "RDS"
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.