DescribeDTCSecurityIpHostsForSQLServer - ApsaraDB RDS - Alibaba Cloud Documentation Center

Queries the distributed transaction whitelists of an ApsaraDB RDS for SQL Server instance.

Operation description

Supported database engines

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.

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

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID. You can call the DescribeDBInstances operation to query the instance ID.	rm-uf6wjk5xxxxxxx
RegionId	string	Yes	The region ID. You can call the DescribeDBInstanceAttribute operation to query the most recent region list.	cn-hangzhou
ResourceGroupId	string	No	The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID.	rg-acfmy*****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
DBInstanceId	string	The instance ID.	rm-uf6wjk5xxxxxxx
RequestId	string	The request ID.	2CA62A70-2203-45C6-8E90-8971D5ACC0C2
IpHostPairNum	string	The number of distributed transaction whitelists.	1
Items	array<object>	Details of distributed transaction whitelists.
	object
SecurityIpHosts	string	The IP address of the ECS instance and the hostname of the Windows computer. Format: `IP address,Hostname`. Multiple values are separated with semicolons (;).	192.168.1.100,k3ecstest
WhitelistGroupName	string	The name of the distributed transaction whitelist.	test1

Examples

Sample success responses

JSONformat

{
  "DBInstanceId": "rm-uf6wjk5xxxxxxx",
  "RequestId": "2CA62A70-2203-45C6-8E90-8971D5ACC0C2",
  "IpHostPairNum": "1",
  "Items": {
    "WhiteListGroups": [
      {
        "SecurityIpHosts": "192.168.1.100,k3ecstest",
        "WhitelistGroupName": "test1"
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2022-08-04	The request parameters of the API has changed	View Change Details