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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String GetPhysicalDatabase

系统规定参数。取值:GetPhysicalDatabase

DbId Long 43153

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

Tid Long 1

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

RegionId String cn-hangzhou

选择DMS的服务地域,用于调用该接口,取值请参见RegionID参数说明

说明 请根据应用所在地就近选择。

返回数据

名称 类型 示例值 描述
RequestId String 7FAD400F-7A5C-4193-8F9A-39D86C4F0231

请求ID。

Database object

物理库信息。

DatabaseId String 43125312

物理库ID。

Host String rm-xxxab3r272.mysql.rds.aliyuncs.com

数据库连接地址。

CatalogName String def

数据库目录名。

说明 PG系列的数据库将显示数据库名。
DbaName String dmstest

目标库的DBA昵称。

State String NORMAL

库状态,取值说明:

  • NORMAL: 正常
  • DISABLE:禁用
  • OFFLINE:下线
  • NOT_EXIST:不存在
DbaId String 43253

目标库的DBA的用户ID。

SchemaName String dmstest

数据库名。

说明 PG系列的数据库将显示模式名。
InstanceId String 43215325

目标库的实例ID。

Port Integer 3306

数据库的连接端口。

EnvType String product

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

Sid String def

数据库SID。

说明 仅Oracle数据库显示。
OwnerIdList Array of String 43215325

库Owner User ID。

Encoding String utf8mb4

数据库编码。

DbType String mysql

数据库类型。

OwnerNameList Array of String dmstest

库Owner昵称。

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

库搜索名称。

ErrorCode String UnknownError

错误码。

ErrorMessage String UnknownError

错误信息。

Success Boolean true

请求是否成功。

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=GetPhysicalDatabase
&DbId=43153
&Tid=1
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetPhysicalDatabaseResponse>
    <RequestId>4EE2B004-9131-44B7-B6EE-6151B6329F68</RequestId>
    <Database>
        <SearchName>film@rm-uf64e.mysql.rds.aliyuncs.com:3306</SearchName>
        <InstanceId>1400000</InstanceId>
        <Port>3306</Port>
        <Encoding>utf8</Encoding>
        <Host>rm-uf64e.mysql.rds.aliyuncs.com</Host>
        <DatabaseId>7000000</DatabaseId>
        <DbType>mysql</DbType>
        <EnvType>dev</EnvType>
        <DbaName>enlun00</DbaName>
        <DbaId>260000</DbaId>
        <State>NORMAL</State>
        <CatalogName>def</CatalogName>
        <OwnerNameList>
            <OwnerNames>enlun</OwnerNames>
        </OwnerNameList>
        <SchemaName>film</SchemaName>
        <OwnerIdList>
            <OwnerIds>26000</OwnerIds>
        </OwnerIdList>
    </Database>
    <Success>true</Success>
</GetPhysicalDatabaseResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "4EE2B004-9131-44B7-B6EE-6151B6329F68",
  "Database" : {
    "SearchName" : "film@rm-uf64e.mysql.rds.aliyuncs.com:3306",
    "InstanceId" : 1400000,
    "Port" : 3306,
    "Encoding" : "utf8",
    "Host" : "rm-uf64e.mysql.rds.aliyuncs.com",
    "DatabaseId" : 7000000,
    "DbType" : "mysql",
    "EnvType" : "dev",
    "DbaName" : "enlun00",
    "DbaId" : 260000,
    "State" : "NORMAL",
    "CatalogName" : "def",
    "OwnerNameList" : {
      "OwnerNames" : [ "enlun" ]
    },
    "SchemaName" : "film",
    "OwnerIdList" : {
      "OwnerIds" : [ 26000 ]
    }
  },
  "Success" : true
}

错误码

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