调用GetInstance获取实例详细信息_数据管理（兼容数据库备份）(DMS)-阿里云帮助中心

获取实例详细信息。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
dms:GetInstance	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
Tid	long	否	租户 ID，可通过调用接口 GetUserActiveTenant 获取该参数的值。	2***
Host	string	是	实例连接地址，可通过调用接口 ListInstances 获取该参数的值。	172.17.XXX.XXX
Port	integer	是	实例连接端口，可通过调用接口 ListInstances 获取该参数的值。	5432
Sid	string	否	实例 Sid，可调用接口 ListInstances 获取该参数的值。	test

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	F6C80B69-3203-56AC-8021-18BA72A6F4E1
Instance	object	实例详细信息。
VpcId	string	实例所属 VPC 的 ID。	vpc-o6wrloqsdqc9io3mg****
DatabaseUser	string	实例登录用户名。	dbuser
DbaId	string	实例 DBA ID。	29****
UseDsql	integer	实例是否开启跨库查询： 0：不开启 1：开启	0
Port	integer	实例连接端口。	5432
EcsInstanceId	string	实例 ECS ID。	i-bp124ldpklqz59y3****
EnvType	string	实例环境类型，返回值如下： product：生产环境 dev：开发环境 pre：预发环境 test：测试环境 sit：SIT 环境 uat：UAT 环境 pet：压测环境 stag：STAG 环境	test
Sid	string	实例 Sid。	test
OwnerIdList	array	实例 Owner UserId 列表。
OwnerIds	string	实例 Owner UserId。	10****
SafeRuleId	string	实例安全规则 ID。	3****
OwnerNameList	array	实例 Owner 昵称列表。
OwnerNames	string	实例 Owner 昵称。	yang_test
DbaNickName	string	实例 DBA 昵称。	dbaname
QueryTimeout	integer	实例查询超时时间。	7200
InstanceSource	string	实例来源。	ECS_OWN
Host	string	实例连接地址。	192.168.XXX.XXX
State	string	实例状态，返回值如下： NORMAL：正常使用 DISABLE：禁用	NORMAL
DataLinkName	string	实例 Datalink 名称。	test
ExportTimeout	integer	实例导出超时时间。	86400
InstanceId	string	实例 ID。	188****
InstanceType	string	实例 DB 类型。	postgresql
DatabasePassword	string	数据库用户密码。	******
InstanceAlias	string	实例别名。	测试
DdlOnline	integer	实例 DdlOnline 配置。	0
EcsRegion	string	实例所属地域。	cn-beijing
StandardGroup	object	实例对应的管控模式信息。
GroupName	string	管控模式对应的安全规则名称。	自由操作
GroupMode	string	管控模式类型，返回值如下： COMMON：安全协同模式 NONE_CONTROL：自由操作模式 STABLE：稳定变更模式	NONE_CONTROL
SellSitd	string	敏感数据保护是否开启，取值： true：开启 false：关闭	false
ErrorCode	string	错误码。	UnknownError
ErrorMessage	string	错误信息。	UnknownError
Success	boolean	请求是否成功，返回值如下： 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": {
      "OwnerIds": [
        "10****"
      ]
    },
    "SafeRuleId": "3****",
    "OwnerNameList": {
      "OwnerNames": [
        "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
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史