GetDatabase - - Alibaba Cloud Dokümantasyon Merkezi

Belirtilen bir veritabanının ayrıntılarını alır.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Tid	integer	No	Kiracının kimliği. Bu kimliği almak için GetUserActiveTenant API'sini çağırabilirsiniz.	-1
Host	string	Yes	Veritabanının uç noktası.	192.168.XX.XX
Port	integer	Yes	Veritabanı bağlantı noktası.	3306
Sid	string	No	Veritabanı SID'si. Not Veritabanı SID'si, bir Oracle veritabanı için benzersiz tanımlayıcıdır.	test_sid
SchemaName	string	Yes	Veritabanı adı.	mysql
RealLoginUserUid	string	No	Yok.

Response elements

Element	Type	Description	Example
	object
RequestId	string	İstek kimliği.	3CDB8601-AD74-4A47-8114-08E08CD6****
Database	object	Veritabanının ayrıntıları.
DatabaseId	string	Veritabanı kimliği.	984****
Host	string	Veritabanı uç noktası.	192.168.XX.XX
CatalogName	string	Veritabanı kataloğunun adı.	def
DbaName	string	DBA'nın takma adı.	dba_name
State	string	Veritabanının durumu. Geçerli değerler: NORMAL: Veritabanı çalışıyor. DISABLED: Veritabanı devre dışı. OFFLINE: Veritabanı çevrim dışı. NOT_EXIST: Veritabanı mevcut değil.	NORMAL
DbaId	string	DBA'nın kullanıcı kimliği.	27****
SchemaName	string	Şema adı.	mysql
InstanceId	string	Örnek kimliği.	149****
Port	integer	Veritabanına bağlanmak için kullanılan bağlantı noktası.	3306
EnvType	string	Veritabanının ortam türü. Geçerli değerler: product: üretim dev: geliştirme pre: ön sürüm test: test sit: sistem entegrasyon testi (SIT) uat: kullanıcı kabul testi (UAT) pet: performans testi stag: hazırlık	product
Sid	string	Veritabanının SID'si. Not Bu parametre yalnızca Oracle veritabanları için döndürülür.	test_sid
OwnerIdList	object	Veritabanı sahiplerinin kimlikleri.
OwnerIds	array	Veritabanı sahiplerinin kullanıcı kimlikleri listesi.
	string	Bir veritabanı sahibinin kullanıcı kimliği.	27****
Encoding	string	Karakter kümesi.	utf8mb4
DbType	string	Veritabanı motoru türü. Daha fazla bilgi için DbType parametresinin açıklamasına bakın.	mysql
OwnerNameList	object	Veritabanı sahiplerinin takma adları.
OwnerNames	array	Veritabanı sahiplerinin takma adları listesi.
	string	Bir veritabanı sahibinin takma adı.	test
SearchName	string	Veritabanını aramak için kullanılan ad.	mysql@192.168.XX.XX:3306
InstanceAlias	string	Örneğin takma adı.	test
ErrorCode	string	Hata kodu.	UnknownError
ErrorMessage	string	Hata mesajı.	An unknown error occurred.
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": "3CDB8601-AD74-4A47-8114-08E08CD6****",
  "Database": {
    "DatabaseId": "984****",
    "Host": "192.168.XX.XX",
    "CatalogName": "def",
    "DbaName": "dba_name",
    "State": "NORMAL",
    "DbaId": "27****",
    "SchemaName": "mysql",
    "InstanceId": "149****",
    "Port": 3306,
    "EnvType": "product",
    "Sid": "test_sid",
    "OwnerIdList": {
      "OwnerIds": [
        "27****"
      ]
    },
    "Encoding": "utf8mb4",
    "DbType": "mysql",
    "OwnerNameList": {
      "OwnerNames": [
        "test"
      ]
    },
    "SearchName": "mysql@192.168.XX.XX:3306",
    "InstanceAlias": "test"
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "An unknown error occurred.",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.