调取DescribeDBInstanceForDms接口查询实例详细信息。

调试

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

请求参数

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

系统规定参数。取值:DescribeDBInstanceForDms

Host String gp-bp12ga6v69h86****-master.gpdb.rds.aliyuncs.com

连接地址DNS域名,不包含端口。

Port Long 5432

端口。

返回数据

名称 类型 示例值 描述
RequestId String B4CAF581-2AC7-41AD-8940-D56DF7AADF5B

请求ID。

Message String ""

失败信息详情。接口调用成功的情况下返回值为空。

Instance Object

实例详细信息。

VpcId String vpc-bp19ame5m1r3oejns****

VPC的ID。

AliUid String 253460731706911258

实例所属的阿里云账号的UID。

Port String 5432

实例连接端口号。

Bid String *****

区分示例值是金融云、政务云或公有云。

VpcCloudInstanceId String vpc-bp19ame5m1r3oejns****

VPC实例的ID。

VSwitchId String vsw-bp1cpq8mr64paltkb****

vSwitch的ID。

Description String ”“

描述信息。

ConnectionString String gp-bp12ga6v69h86****-master.gpdbmaster.singapore.rds.aliyuncs.com

实例连接串地址。

Version String 6.0

实例版本。

DbType String gpdb

数据库类型。

InstanceNetworkType String vpc

实例网络类型。

Region String ap-southeast-1

Region地址。

DbInstanceName String gp-bp12ga6v69h86****

实例ID。

VpcIp String 172.16.0.140

VPC的IP地址。

HttpStatusCode Integer 200

通用HTTP返回码。

Count Long 1

实例数量。

Code String "200"

内部返回码。

Success Boolean true

是否成功。

示例

请求示例

http(s)://gpdb.aliyuncs.com/?Action=DescribeDBInstanceForDms
&Host=gp-bp12ga6v69h86****-master.gpdb.rds.aliyuncs.com
&Port=5432
&公共请求参数

正常返回示例

XML格式

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

<DescribeDBInstanceForDmsResponse>
    <RequestId>B4CAF581-2AC7-41AD-8940-D56DF7AADF5B</RequestId>
    <Message>""</Message>
    <Instance>
        <VpcId>vpc-bp19ame5m1r3oejns****</VpcId>
        <AliUid>253460731706911258</AliUid>
        <Port>5432</Port>
        <Bid>*****</Bid>
        <VpcCloudInstanceId>vpc-bp19ame5m1r3oejns****</VpcCloudInstanceId>
        <VSwitchId>vsw-bp1cpq8mr64paltkb****</VSwitchId>
        <Description>”“</Description>
        <ConnectionString>gp-bp12ga6v69h86****-master.gpdbmaster.singapore.rds.aliyuncs.com</ConnectionString>
        <Version>6.0</Version>
        <DbType>gpdb</DbType>
        <InstanceNetworkType>vpc</InstanceNetworkType>
        <Region>ap-southeast-1</Region>
        <DbInstanceName>gp-bp12ga6v69h86****</DbInstanceName>
        <VpcIp>172.16.0.140</VpcIp>
    </Instance>
    <HttpStatusCode>200</HttpStatusCode>
    <Count>1</Count>
    <Code>"200"</Code>
    <Success>true</Success>
</DescribeDBInstanceForDmsResponse>

JSON格式

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

{
  "RequestId" : "B4CAF581-2AC7-41AD-8940-D56DF7AADF5B",
  "Message" : "\"\"",
  "Instance" : {
    "VpcId" : "vpc-bp19ame5m1r3oejns****",
    "AliUid" : "253460731706911258",
    "Port" : "5432",
    "Bid" : "*****",
    "VpcCloudInstanceId" : "vpc-bp19ame5m1r3oejns****",
    "VSwitchId" : "vsw-bp1cpq8mr64paltkb****",
    "Description" : "”“",
    "ConnectionString" : "gp-bp12ga6v69h86****-master.gpdbmaster.singapore.rds.aliyuncs.com",
    "Version" : "6.0",
    "DbType" : "gpdb",
    "InstanceNetworkType" : "vpc",
    "Region" : "ap-southeast-1",
    "DbInstanceName" : "gp-bp12ga6v69h86****",
    "VpcIp" : "172.16.0.140"
  },
  "HttpStatusCode" : 200,
  "Count" : 1,
  "Code" : "\"200\"",
  "Success" : true
}

错误码

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