ModifyDTCSecurityIpHostsForSQLServer - ApsaraDB RDS - Alibaba Cloud Documentation Center

Configures a distributed transaction whitelist for an ApsaraDB for RDS instance.

Operation Description

The ID of the instance.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
rds:ModifyDTCSecurityIpHostsForSQLServer	WRITE	RDS acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The name of the whitelist.	rm-uf6wjk5xxxxxxx
SecurityIpHosts	string	Yes	The ID of the region. You can call the DescribeRegions operation to query the most recent region list.	192.168.1.100,k3ecstest
WhiteListGroupName	string	Yes	The ID of the instance.	test1
RegionId	string	Yes	The ID of the request.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object
DBInstanceId	string	The ID of the task.	rm-uf6wjk5xxxxxxx
RequestId	string	The result of the whitelist configuration. Valid values: Success Fail	671B6D32-B907-4EFF-A3B7-94D2EAD5E3A3
TaskId	string	Distributed transaction whitelists allow for distributed transactions between an Elastic Compute Service (ECS) instance and an RDS instance. For more information, see Configure a distributed transaction whitelist. This operation is applicable to instances that run one of the following SQL Server versions in the RDS High-Availability Edition: 2012 SE, 2012 EE, 2014 SE, 2016 SE, 2016 EE, and 2017 SE.	178968983

Examples

Sample success responses

JSONformat

{
	"RequestId": "671B6D32-B907-4EFF-A3B7-94D2EAD5E3A3",
	"DBInstanceId": "rm-uf6wjk5xxxxxxx",
	"DTCSetResult": "Success",
	"TaskId": 178968983
}

XMLformat

<ModifyDTCSecurityIpHostsForSQLServerResponse>
<RequestId>671B6D32-B907-4EFF-A3B7-94D2EAD5E3A3</RequestId>
	<DBInstanceId>rm-uf6wjk5xxxxxxx</DBInstanceId>
	<DTCSetResult>Success</DTCSetResult>
	<TaskId>178968983</TaskId>
</ModifyDTCSecurityIpHostsForSQLServerResponse>

Error codes

For a list of error codes, visit the Service error codes.