调用GetPhysicalDatabase获取物理库的详情_数据管理(DMS)-阿里云帮助中心

调用GetPhysicalDatabase获取物理库的详情。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
DbId	long	是	物理库 ID，您可以调用 SearchDatabase 接口获取该值。	43153
Tid	long	否	租户 ID，您可以调用 GetUserActiveTenant 接口获取该参数。	1

返回参数

名称	类型	描述	示例值
	object	请求返回。
RequestId	string	请求 ID。	7FAD400F-7A5C-4193-8F9A-39D86C4F0231
Database	object	物理库信息。
DatabaseId	string	物理库 ID。	43125312
Host	string	数据库连接地址。	rm-xxxab3r272.mysql.rds.aliyuncs.com
CatalogName	string	数据库目录名。说明 PG 系列的数据库将显示数据库名。	def
DbaName	string	目标库的 DBA 昵称。	dmstest
State	string	库状态，取值说明： NORMAL：正常 DISABLE：禁用 OFFLINE：下线 NOT_EXIST：不存在	NORMAL
DbaId	string	目标库的 DBA 的用户 ID。	43253
SchemaName	string	数据库名。说明 PG 系列的数据库将显示模式名。	dmstest
InstanceId	string	目标库的实例 ID。	43215325
Port	integer	数据库的连接端口。	3306
EnvType	string	数据库的环境类型，更多信息，请参见环境说明。	product
Sid	string	数据库 SID。说明仅 Oracle 数据库显示。	def
OwnerIdList	array	库 Owner User ID 列表。
	string	库 Owner User ID。	43215325
Encoding	string	数据库编码。	utf8mb4
DbType	string	数据库类型。	mysql
OwnerNameList	array	库 Owner 昵称列表。
	string	库 Owner 昵称。	dmstest
SearchName	string	库搜索名称。	dmstest@rm-xxxab3r272.mysql.rds.aliyuncs.com:3306
InstanceAlias	string	实例别名。	test
ErrorCode	string	错误码。	UnknownError
ErrorMessage	string	错误信息。	UnknownError
Success	boolean	请求是否成功。	true

示例

正常返回示例

JSON格式

{
  "RequestId": "7FAD400F-7A5C-4193-8F9A-39D86C4F0231",
  "Database": {
    "DatabaseId": "43125312",
    "Host": "rm-xxxab3r272.mysql.rds.aliyuncs.com",
    "CatalogName": "def",
    "DbaName": "dmstest",
    "State": "NORMAL",
    "DbaId": "43253",
    "SchemaName": "dmstest",
    "InstanceId": "43215325",
    "Port": 3306,
    "EnvType": "product",
    "Sid": "def",
    "OwnerIdList": {
      "OwnerIds": [
        "43215325"
      ]
    },
    "Encoding": "utf8mb4",
    "DbType": "mysql",
    "OwnerNameList": {
      "OwnerNames": [
        "dmstest"
      ]
    },
    "SearchName": "dmstest@rm-xxxab3r272.mysql.rds.aliyuncs.com:3306",
    "InstanceAlias": "test"
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2023-05-18	OpenAPI 返回结构发生变更	查看变更详情