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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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:DescribeDTCSecurityIpHostsForSQLServer	get	*DBInstance `acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}`	rds:ResourceTag	none

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.
WhiteListGroups	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
2024-11-20	API Description Update. The Error code has changed	View Change Details
2022-08-04	The request parameters of the API has changed	View Change Details