登录测试 - ValidateInstanceConnection

功能介绍

RDS for SQL Server实例间或与远程SQL Server数据库的连通性测试。

调用接口前，您需要了解API认证鉴权。
调用接口前，您需要了解请求Header参数说明。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
rds:instance:update	write	-	-	rds:instance:modify	-

URI

URI格式
 POST /v3/{project_id}/instances/{instance_id}/replication/login-test

参数说明

表1 参数说明
名称	是否必选	说明
project_id	是	参数解释：租户在某一region下的project ID。获取方法请参见获取项目ID。约束限制：非空。取值范围：不涉及。默认取值：不涉及。
instance_id	是	参数解释：实例ID。约束限制：非空。取值范围：不涉及。默认取值：不涉及。

请求参数

表2 参数说明
名称	是否必选	参数类型	说明
target_instance_id	否	String	参数解释：连接目标实例ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
user_info	否	Object	参数解释：用户登录信息。详情请参见表3。约束限制：此项仅在target_instance_id为空时生效。

表3 user_info元素结构说明
名称	是否必选	参数类型	说明
server_ip	否	String	参数解释：服务器IP。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
server_port	否	Integer	参数解释：端口号。约束限制：不涉及。取值范围：不涉及默认取值：不涉及
login_user_name	否	String	参数解释：登录名。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
login_user_password	否	String	参数解释：登录密码。约束限制：不涉及。取值范围：要求密码长度在5~64位之间。默认取值：不涉及。

请求示例

RDS for SQL Server实例间的连通性测试。

POST https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/72ee4cc4607347049df9ad50f615bbd8in04/replication/login-test

{
    "target_instance_id": "56a83b2252ab4d0eb846538fc8ecacd4in04"
}

RDS for SQL Server实例与用户自建SQL Server数据库的连通性测试。

POST https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/72ee4cc4607347049df9ad50f615bbd8in04/replication/login-test

{
    "user_info": {
        "server_ip": "192.168.0.70",
        "server_port": "1433",
        "login_user_name": "rdsuser",
        "login_user_password": "**********"
    }
}