Testing Connectivity

Function

This API is used to test connectivity between one RDS for SQL Server instance and another RDS for SQL Server instance or a remote SQL Server database

Before calling this API, learn how to authenticate it.
Before calling this API, learn about request header parameters.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
rds:instance:update	write	-	-	rds:instance:modify	-

URI

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

Parameter description

**Table 1** Parameters
Parameter	Mandatory	Description
project_id	Yes	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints The value cannot be empty. Range N/A Default Value N/A
instance_id	Yes	Definition Instance ID. Constraints The value cannot be empty. Range N/A Default Value N/A

Request Parameters

**Table 2** Parameters
Parameter	Mandatory	Type	Description
target_instance_id	No	String	Definition Target instance ID. Constraints N/A Range N/A Default Value N/A
user_info	No	Object	Definition User login information. For details, see Table 3. Constraints This parameter is valid only when target_instance_id is left blank.

**Table 3** user_info element structure description
Parameter	Mandatory	Type	Description
server_ip	No	String	Definition Server IP address. Constraints N/A Range N/A Default Value N/A
server_port	No	Integer	Definition Port number. Constraints N/A Range N/A Default Value N/A
login_user_name	No	String	Definition Login name. Constraints N/A Range N/A Default Value N/A
login_user_password	No	String	Definition Login password. Constraints N/A Range The password must contain 5 to 64 characters. Default Value N/A

Example Request

Test connectivity between two RDS for SQL Server instances.

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

{
    "target_instance_id": "56a83b2252ab4d0eb846538fc8ecacd4in04"
}

Test connectivity between an RDS for SQL Server instance and a self-managed SQL Server database.

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": "**********"
    }
}