调用GetInstance获取实例详细信息。

调试

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

请求参数

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

系统规定参数。取值：GetInstance。

Tid Long 是 2***

租户ID，可通过调用接口GetUserActiveTenant获取该参数的值。

Host String 是 172.17.XXX.XXX

实例连接地址，可通过调用接口ListInstances获取该参数的值。

Port Integer 是 5432

实例连接端口，可通过调用接口ListInstances获取该参数的值。

Sid String 否 test

实例Sid，可调用接口ListInstances获取该参数的值。

返回数据

名称 类型 示例值 描述
RequestId String F6C80B69-3203-56AC-8021-18BA72A6F4E1

请求ID。
Instance Object

实例详细信息。
VpcId String vpc-o6wrloqsdqc9io3mg****

实例所属VPC的ID。
DatabaseUser String dbuser

实例登录用户名。
DbaId String 29****

实例DBA ID。
UseDsql Integer 0

实例是否开启跨库查询：

  • 0：不开启
  • 1：开启
Port Integer 5432

实例连接端口。
EcsInstanceId String i-bp124ldpklqz59y3****

实例ECS ID。
EnvType String test

实例环境类型，返回值如下：

  • product：生产环境
  • dev：开发环境
  • pre：预发环境
  • test：测试环境
  • sit：SIT环境
  • uat：UAT环境
  • pet：压测环境
  • stag：STAG环境
Sid String test

实例Sid。
OwnerIdList Array of String 10****

实例Owner UserId。
SafeRuleId String 3****

实例安全规则ID。
OwnerNameList Array of String yang_test

实例Owner昵称。
DbaNickName String dbaname

实例DBA昵称。
QueryTimeout Integer 7200

实例查询超时时间。
InstanceSource String ECS_OWN

实例来源。
Host String 192.168.XXX.XXX

实例连接地址。
State String NORMAL

实例状态，返回值如下：

  • NORMAL：正常使用
  • DISABLE：禁用
DataLinkName String test

实例Datalink名称。
ExportTimeout Integer 86400

实例导出超时时间。
InstanceId String 188****

实例ID。
InstanceType String postgresql

实例DB类型。
DatabasePassword String ******

数据库用户密码。
InstanceAlias String 测试

实例别名。
DdlOnline Integer 0

实例DdlOnline配置。
EcsRegion String cn-beijing

实例所属地域。
StandardGroup Object

实例对应的管控模式信息。
GroupName String 自由操作

管控模式对应的安全规则名称。
GroupMode String NONE_CONTROL

管控模式类型，返回值如下：

  • COMMON：安全协同模式
  • NONE_CONTROL：自由操作模式
  • STABLE：稳定变更模式
SellSitd String false

敏感数据保护是否开启，取值：

  • true：开启
  • false：关闭
ErrorCode String UnknownError

错误码。
ErrorMessage String UnknownError

错误信息。
Success Boolean true

请求是否成功，返回值如下：

  • true：请求成功
  • false：请求失败

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=GetInstance
&Tid=1
&Host=172.17.XXX.XXX
&Port=5432
&Sid=test
&公共请求参数

正常返回示例

XML格式 

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

<GetInstanceResponse>
    <RequestId>F6C80B69-3203-56AC-8021-18BA72A6F4E1</RequestId>
    <Instance>
        <Port>5432</Port>
        <DatabasePassword>******</DatabasePassword>
        <ExportTimeout>86400</ExportTimeout>
        <EnvType>test</EnvType>
        <DbaId>12****</DbaId>
        <InstanceAlias>测试</InstanceAlias>
        <EcsRegion>cn-beijing</EcsRegion>
        <InstanceType>postgresql</InstanceType>
        <QueryTimeout>7200</QueryTimeout>
        <DataLinkName>dbl_postgresql_2</DataLinkName>
        <SafeRuleId>3****</SafeRuleId>
        <SellSitd>false</SellSitd>
        <InstanceSource>ECS_OWN</InstanceSource>
        <StandardGroup>
            <GroupName>自由操作</GroupName>
            <GroupMode>NONE_CONTROL</GroupMode>
        </StandardGroup>
        <InstanceId>188****</InstanceId>
        <Host>172.17.XXX.XXX</Host>
        <DdlOnline>0</DdlOnline>
        <UseDsql>0</UseDsql>
        <EcsInstanceId>i-bp124ldpklqz59y3****</EcsInstanceId>
        <State>NORMAL</State>
        <DatabaseUser>postgres</DatabaseUser>
        <OwnerNameList>
            <OwnerNames>yang_test</OwnerNames>
        </OwnerNameList>
        <DbaNickName>dbaname</DbaNickName>
        <OwnerIdList>
            <OwnerIds>10****</OwnerIds>
        </OwnerIdList>
    </Instance>
    <Success>true</Success>
</GetInstanceResponse>

JSON格式 

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

{
  "RequestId" : "F6C80B69-3203-56AC-8021-18BA72A6F4E1",
  "Instance" : {
    "Port" : 5432,
    "DatabasePassword" : "******",
    "ExportTimeout" : 86400,
    "EnvType" : "test",
    "DbaId" : "12****",
    "InstanceAlias" : "测试",
    "EcsRegion" : "cn-beijing",
    "InstanceType" : "postgresql",
    "QueryTimeout" : 7200,
    "DataLinkName" : "dbl_postgresql_2",
    "SafeRuleId" : "3****",
    "SellSitd" : false,
    "InstanceSource" : "ECS_OWN",
    "StandardGroup" : {
      "GroupName" : "自由操作",
      "GroupMode" : "NONE_CONTROL"
    },
    "InstanceId" : "188****",
    "Host" : "172.17.XXX.XXX",
    "DdlOnline" : 0,
    "UseDsql" : "0",
    "EcsInstanceId" : "i-bp124ldpklqz59y3****",
    "State" : "NORMAL",
    "DatabaseUser" : "postgres",
    "OwnerNameList" : {
      "OwnerNames" : [ "yang_test" ]
    },
    "DbaNickName" : "dbaname",
    "OwnerIdList" : {
      "OwnerIds" : [ "10****" ]
    }
  },
  "Success" : true
}

错误码

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