All Products
Search
Document Center

ApsaraDB RDS:ModifyDTCSecurityIpHostsForSQLServer

Last Updated:May 22, 2024

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

Operation description

Supported database engine

SQL Server

References

Note Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.

Configure a distributed transaction whitelist

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
rds:ModifyDTCSecurityIpHostsForSQLServerWrite
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The instance ID. You can call the DescribeDBInstances operation to query the instance ID.

rm-uf6wjk5xxxxxxx
SecurityIpHostsstringYes

The IP address of the ECS instance and the hostname of the Windows computer. Format: IP address,Hostname. Separate multiple entries with semicolon (;).

Note For more information about how to query the computer hostname, see Configure a distributed transaction whitelist.
192.168.1.100,k3ecstest
WhiteListGroupNamestringYes

The name of the IP address whitelist.

test1
RegionIdstringYes

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

DBInstanceIdstring

The instance ID.

rm-uf6wjk5xxxxxxx
RequestIdstring

The request ID.

671B6D32-B907-4EFF-A3B7-94D2EAD5E3A3
TaskIdstring

The task ID.

178968983
DTCSetResultstring

The result of the IP address whitelist configuration. Valid values:

  • Success
  • Fail
Success

Examples

Sample success responses

JSONformat

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

Error codes

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