使用SimplyAddInstance接口添加数据库实例-数据管理 DMS-阿里云-数据管理 DMS-阿里云帮助中心

接口说明

系统角色为 DBA 或管理员。查看系统角色的操作，请参见查看我的系统角色。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dms:SimplyAddInstance

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	否	阿里云实例资源 ID。	rm****
InstanceRegion	string	否	实例所在地域。	cn-hangzhou
Host	string	否	数据库连接地址。	192.XXX.0.56
Port	integer	否	实例连接端口。	5432
DatabaseUser	string	是	数据库用户名。	abc
DatabasePassword	string	是	数据库密码。	test***
RealLoginUserUid	string	否	实际调用 API 的用户的阿里云账号 UID	21400447956867****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。请求的唯一标识，用于定位日志，排查问题。	7FAD400F-7A5C-4193-8F9A-39D86C4F0231
ErrorCode	string	错误码。取值说明如下：请求成功不返回 ErrorCode 字段。请求失败返回 ErrorCode 字段。具体信息，请参见返回示例下方的错误码。	403
ErrorMessage	string	错误信息。	UnknownError
Success	boolean	请求是否成功，取值： true：请求成功。 false：请求失败。	true
Instance	object	实例详细信息。
InstanceId	string	DMS 中的实例 ID。	188****
Host	string	实例连接地址。	192.168.XXX.XXX
Port	string	实例连接端口。	5432

示例

正常返回示例

JSON格式

{
  "RequestId": "7FAD400F-7A5C-4193-8F9A-39D86C4F0231",
  "ErrorCode": "403",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "Instance": {
    "InstanceId": "188****",
    "Host": "192.168.XXX.XXX",
    "Port": "5432"
  }
}

错误码

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

变更历史

更多信息，参考变更详情。