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

调试

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

请求参数

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

系统规定参数。取值:GetInstance

Tid Long 2***

租户ID,获取租户ID请参见查看租户信息

Host String 192.168.XXX.XXX

实例连接地址。您可以调用ListInstances接口,获取该参数的值。

Port Integer 3306

实例连接端口。您可以调用ListInstances接口,获取该参数的值。

Sid String test

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

RegionId String cn-hangzhou

选择DMS的服务地域,取值请参见RegionID参数说明

返回数据

名称 类型 示例值 描述
RequestId String E495CF94-818F-5FFE-ADD7-863ACBECBCA0

请求ID。

Instance Object

实例详细信息。

VpcId String vpc-o6wrloqsdqc9io3mg****

实例所属VPC的ID。

DatabaseUser String dbuser

实例登录用户名。

DbaId String 29****

实例DBA ID。

UseDsql Integer 0

实例是否开启跨库查询:

  • 0:不开启
  • 1:开启
Port Integer 3306

实例连接端口。

EcsInstanceId String i-bp124ldpklqz59y3****

实例ECS ID。

EnvType String product

实例环境类型,返回值如下:

  • 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 yuyang_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 168****

实例ID。

InstanceType String mysql

实例DB类型。

DatabasePassword String ******

数据库用户密码。

InstanceAlias String test

实例别名。

DdlOnline Integer 0

实例DdlOnline配置。

EcsRegion String cn-hangzhou

实例所属地域。

StandardGroup Object

实例对应的管控模式信息。

GroupName String test group name

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

GroupMode String COMMON

管控模式类型,取值如下:

  • COMMON:安全协同模式
  • NONE_CONTROL:自由操作模式
  • STABLE:稳定变更模式
ErrorCode String UnknownError

错误码。

ErrorMessage String UnknownError

错误信息。

Success Boolean true

接口调用是否成功。

  • true:执行成功。
  • false:执行失败。

示例

请求示例

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

正常返回示例

XML格式

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

<GetInstanceResponse>
    <RequestId>E495CF94-818F-5FFE-ADD7-863ACBECBCA0</RequestId>
    <Instance>
        <VpcId>vpc-o6wrloqsdqc9io3mg****</VpcId>
        <DatabaseUser>dbuser</DatabaseUser>
        <DbaId>29****</DbaId>
        <UseDsql>0</UseDsql>
        <Port>3306</Port>
        <EcsInstanceId>i-bp124ldpklqz59y3****</EcsInstanceId>
        <EnvType>product</EnvType>
        <Sid>test</Sid>
        <OwnerIdList>10****</OwnerIdList>
        <SafeRuleId>3****</SafeRuleId>
        <OwnerNameList>yuyang_test</OwnerNameList>
        <DbaNickName>dbaname</DbaNickName>
        <QueryTimeout>7200</QueryTimeout>
        <InstanceSource>ECS_OWN</InstanceSource>
        <Host>192.168.XXX.XXX</Host>
        <State>NORMAL</State>
        <DataLinkName>test</DataLinkName>
        <ExportTimeout>86400</ExportTimeout>
        <InstanceId>168****</InstanceId>
        <InstanceType>mysql</InstanceType>
        <DatabasePassword>******</DatabasePassword>
        <InstanceAlias>test</InstanceAlias>
        <DdlOnline>0</DdlOnline>
        <EcsRegion>cn-hangzhou</EcsRegion>
        <StandardGroup>
            <GroupName>test group name</GroupName>
            <GroupMode>COMMON</GroupMode>
        </StandardGroup>
    </Instance>
    <ErrorCode>UnknownError</ErrorCode>
    <ErrorMessage>UnknownError</ErrorMessage>
    <Success>true</Success>
</GetInstanceResponse>

JSON格式

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

{
  "RequestId" : "E495CF94-818F-5FFE-ADD7-863ACBECBCA0",
  "Instance" : {
    "VpcId" : "vpc-o6wrloqsdqc9io3mg****",
    "DatabaseUser" : "dbuser",
    "DbaId" : "29****",
    "UseDsql" : 0,
    "Port" : 3306,
    "EcsInstanceId" : "i-bp124ldpklqz59y3****",
    "EnvType" : "product",
    "Sid" : "test",
    "OwnerIdList" : [ "10****" ],
    "SafeRuleId" : "3****",
    "OwnerNameList" : [ "yuyang_test" ],
    "DbaNickName" : "dbaname",
    "QueryTimeout" : 7200,
    "InstanceSource" : "ECS_OWN",
    "Host" : "192.168.XXX.XXX",
    "State" : "NORMAL",
    "DataLinkName" : "test",
    "ExportTimeout" : 86400,
    "InstanceId" : "168****",
    "InstanceType" : "mysql",
    "DatabasePassword" : "******",
    "InstanceAlias" : "test",
    "DdlOnline" : 0,
    "EcsRegion" : "cn-hangzhou",
    "StandardGroup" : {
      "GroupName" : "test group name",
      "GroupMode" : "COMMON"
    }
  },
  "ErrorCode" : "UnknownError",
  "ErrorMessage" : "UnknownError",
  "Success" : true
}

错误码

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