All Products
Document Center

ApsaraDB RDS:DescribeDBInstanceIpHostname

Last Updated:May 11, 2024

Queries the hostname of the Elastic Compute Service (ECS) instance on which the ApsaraDB RDS for SQL Server instance runs.

Operation description

Supported database engines

RDS SQL Server


  • The RDS instance runs RDS Basic Edition, RDS High-availability Edition, or RDS Cluster Edition. If your RDS instance runs RDS High-availability Edition, make sure that the instance runs SQL Server 2012 or later.
  • The RDS instance belongs to a general-purpose or dedicated instance family. The shared instance family is not supported.
  • If the RDS instance runs RDS Basic Edition, the instance is created on or after September 02, 2022. You can view the Creation Time


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


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
  • DBInstance
  • rds:ResourceTag

Request parameters


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


You can call the DescribeDBInstanceAttribute operation to query the region ID.


Response parameters


The response parameters.


The instance ID.


The request ID.


The internal IP addresses and hostnames of the ECS instances on which the primary and secondary instances reside. Format: IP address 1,Hostname 1;IP address 2,Hostname 2.



Sample success responses


  "DBInstanceId": "rm-uf6wjk5xxxxxxx",
  "RequestId": "67CD4719-51E3-4A76-A38C-02F45FAE7E36",
  "IpHostnameInfos": "172.16.xx.xx,sdxxxxxxxxB;172.16.xx.xx,sdxxxxxxxxA"

Error codes

HTTP status codeError codeError messageDescription
400EngineNotSupportedEngine specified cannot be supported the operation.The operation failed. This operation is not supported for the database engine version of the RDS instance. Update the minor engine version of the RDS instance.
400InvalidEngineVersion.MalformedSpecified engine version is not valid.The database engine version is invalid. Check the database engine version and try again.
403IncorrectDBInstanceTypeCurrent DB instance engine and type does not support operations.The operation failed. The operation is not supported for the database engine of the RDS instance.
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.-
404InvalidDBInstanceName.NotFoundInvalid DBInstanceId NotFound.The instance ID cannot be found.

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

Change history

Change timeSummary of changesOperation
2022-06-23API Description Updatesee changesets
Change itemChange content
API DescriptionAPI Description Update.