首页 数据管理 DMS API参考 API目录 实例管理 GetInstance - 获取实例详细信息

GetInstance - 获取实例详细信息

获取实例详细信息。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dms:GetInstanceRead
  • DMSEnterprise
    *

请求参数

名称类型必填描述示例值
Tidlong

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

2***
Hoststring

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

172.17.XXX.XXX
Portinteger

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

5432
Sidstring

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

test

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID。

F6C80B69-3203-56AC-8021-18BA72A6F4E1
Instanceobject

实例详细信息。

VpcIdstring

实例所属VPC的ID。

vpc-o6wrloqsdqc9io3mg****
DatabaseUserstring

实例登录用户名。

dbuser
DbaIdstring

实例DBA ID。

29****
UseDsqlinteger

实例是否开启跨库查询:

  • 0:不开启
  • 1:开启
0
Portinteger

实例连接端口。

5432
EcsInstanceIdstring

实例ECS ID。

i-bp124ldpklqz59y3****
EnvTypestring

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

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

实例Sid。

test
OwnerIdListarray

实例Owner UserId列表。

string

实例Owner UserId。

10****
SafeRuleIdstring

实例安全规则ID。

3****
OwnerNameListarray

实例Owner昵称列表。

string

实例Owner昵称。

yang_test
DbaNickNamestring

实例DBA昵称。

dbaname
QueryTimeoutinteger

实例查询超时时间。

7200
InstanceSourcestring

实例来源。

ECS_OWN
Hoststring

实例连接地址。

192.168.XXX.XXX
Statestring

实例状态,返回值如下:

  • NORMAL:正常使用
  • DISABLE:禁用
NORMAL
DataLinkNamestring

实例Datalink名称。

test
ExportTimeoutinteger

实例导出超时时间。

86400
InstanceIdstring

实例ID。

188****
InstanceTypestring

实例DB类型。

postgresql
DatabasePasswordstring

数据库用户密码。

******
InstanceAliasstring

实例别名。

测试
DdlOnlineinteger

实例DdlOnline配置。

0
EcsRegionstring

实例所属地域。

cn-beijing
StandardGroupobject

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

GroupNamestring

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

自由操作
GroupModestring

管控模式类型,返回值如下:

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

敏感数据保护是否开启,取值:

  • true:开启

  • false:关闭

false
ErrorCodestring

错误码。

UnknownError
ErrorMessagestring

错误信息。

UnknownError
Successboolean

请求是否成功,返回值如下:

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

示例

正常返回示例

JSON格式

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

错误码

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

阿里云首页 数据管理 DMS 相关技术圈