All Products
Search
Document Center

ApsaraDB RDS:DescribeDTCSecurityIpHostsForSQLServer

Last Updated:May 29, 2023

You can call the DescribeDTCSecurityIpHostsForSQLServer operation to query the distributed transaction whitelists of an ApsaraDB 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.
OperationAccess levelResource typeCondition keyAssociated operation
rds:DescribeDTCSecurityIpHostsForSQLServerREAD
  • RDS
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

Details of distributed transaction whitelists.

rm-uf6wjk5xxxxxxx
RegionIdstringYes

The ID of the resource group.

cn-hangzhou
ResourceGroupIdstringNo

The ID of the instance.

rg-acfmy*****

Response parameters

ParameterTypeDescriptionExample
object
DBInstanceIdstring

The ID of the request.

rm-uf6wjk5xxxxxxx
RequestIdstring

The operation that you want to perform. Set the value to DescribeDTCSecurityIpHostsForSQLServer.

2CA62A70-2203-45C6-8E90-8971D5ACC0C2
IpHostPairNumstring

The IP address of the ECS instance and the hostname of the Windows computer. Format: IP address,Hostname. Multiple values are separated with semicolons (;).

1

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 timeSummary of changesOperation
2022-08-04The input parameters of the API operation change.
Change itemChange content
Input ParametersThe input parameters of the API operation change.
    Added Input Parameters: ResourceGroupId