文档

GetPhysicalDatabase - 获取物理库的详情

更新时间:

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dms:GetPhysicalDatabaseRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
DbIdlong

物理库 ID,您可以调用 SearchDatabase 接口获取该值。

43153
Tidlong

租户 ID,您可以调用 GetUserActiveTenant 接口获取该参数。

1

返回参数

名称类型描述示例值
object

请求返回。

RequestIdstring

请求 ID。

7FAD400F-7A5C-4193-8F9A-39D86C4F0231
Databaseobject

物理库信息。

DatabaseIdstring

物理库 ID。

43125312
Hoststring

数据库连接地址。

rm-xxxab3r272.mysql.rds.aliyuncs.com
CatalogNamestring

数据库目录名。

说明 PG 系列的数据库将显示数据库名。
def
DbaNamestring

目标库的 DBA 昵称。

dmstest
Statestring

库状态,取值说明:

  • NORMAL: 正常
  • DISABLE:禁用
  • OFFLINE:下线
  • NOT_EXIST:不存在
NORMAL
DbaIdstring

目标库的 DBA 的用户 ID。

43253
SchemaNamestring

数据库名。

说明 PG 系列的数据库将显示模式名。
dmstest
InstanceIdstring

目标库的实例 ID。

43215325
Portinteger

数据库的连接端口。

3306
EnvTypestring

数据库的环境类型,更多信息,请参见环境说明

product
Sidstring

数据库 SID。

说明 仅 Oracle 数据库显示。
def
OwnerIdListarray

库 Owner User ID 列表。

string

库 Owner User ID。

43215325
Encodingstring

数据库编码。

utf8mb4
DbTypestring

数据库类型。

mysql
OwnerNameListarray

库 Owner 昵称列表。

string

库 Owner 昵称。

dmstest
SearchNamestring

库搜索名称。

dmstest@rm-xxxab3r272.mysql.rds.aliyuncs.com:3306
InstanceAliasstring

实例别名。

test
ErrorCodestring

错误码。

UnknownError
ErrorMessagestring

错误信息。

UnknownError
Successboolean

请求是否成功。

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-18OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈