Call the GetPhysicalDatabase to obtain the details of the physical library.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetPhysicalDatabase

The operation that you want to perform. Set the value to GetPhysicalDatabase .

DbId Long Yes 43153

The physical library ID, you can call SearchDatabase The interface obtains the value.

Tid Long No 1

The tenant ID, you can call GetUserActiveTenant The interface obtains the parameter.

RegionId String No cn-hangzhou

Select the service region of DMS to call the interface. For the value, see RegionID parameter .

Note Set this parameter to the ID of the region that is close to your services.

Response parameters

Parameter Type Example Description
RequestId String 7FAD400F-7A5C-4193-8F9A-39D86C4F0231

The ID of the request.

Database object

The physical library information.

DatabaseId String 43125312

The physical library ID.

Host String

The endpoint that is used to connect to the instance.

CatalogName String def

The database directory name.

Note The database name of the PG series will be displayed.
DbaName String dmstest

The DBA nickname of the destination library.

State String NORMAL

Library status, value description:

  • NORMAL : normal
  • DISABLE : disabled
  • OFFLINE : offline
  • NOT_EXIST : does not exist
DbaId String 43253

The user ID of the DBA of the destination library.

SchemaName String dmstest

The name of the database.

Note The PG series database will display the schema name.
InstanceId String 43215325

The instance ID of the destination library.

Port Integer 3306

The connection port of the database.

EnvType String product

The environment type of the database. For more information, see Environment settings .

Sid String def

The database SID.

Note Only Oracle databases are displayed.
OwnerIdList Array of String 43215325

Library Owner User ID.

Encoding String utf8mb4

Database encoding.

DbType String mysql

The type of the storage instance of the DRDS database.

OwnerNameList Array of String dmstest

Library Owner nickname.

SearchName String

The library search name.

ErrorCode String UnknownError

The error code that is returned.

ErrorMessage String UnknownError

The error message that is returned.

Success Boolean true

Indicates whether the call was successful.


Sample requests

     http(s):// &DbId=43153 &Tid=1&Public request parameters 

Sample success responses

XML format

     HTTP/1.1 200 OK Content-Type:application/xml <GetPhysicalDatabaseResponse> <RequestId>4EE2B004-9131-44B7-B6EE-6151B6329F68</RequestId> <Database> <SearchName></SearchName> <InstanceId>1400000</InstanceId> <Port>3306</Port> <Encoding>utf8</Encoding> <Host></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 Format

     HTTP/1.1 200 OK Content-Type:application/json { "RequestId" : "4EE2B004-9131-44B7-B6EE-6151B6329F68", "Database" : { "SearchName" : "", "InstanceId" : 1400000, "Port" : 3306, "Encoding" : "utf8", "Host" : "", "DatabaseId" : 7000000, "DbType" : "mysql", "EnvType" : "dev", "DbaName" : "enlun00", "DbaId" : 260000, "State" : "NORMAL", "CatalogName" : "def", "OwnerNameList" : { "OwnerNames" : [ "enlun" ] }, "SchemaName" : "film", "OwnerIdList" : { "OwnerIds" : [ 26000 ] } }, "Success" : true } 

Error codes

Access Error Center See more error codes.