All Products
Search

This Product

    Bastionhost:ListDatabases

    Document Center

    Bastionhost:ListDatabases

    Last Updated:Nov 27, 2024

    Queries the databases that are managed by a bastion host.

    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.

    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
    yundun-bastionhost:ListDatabases
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InstanceIdstringYes

    The ID of the bastion host to query.

    Note You can call the DescribeInstances operation to query the ID of the bastion host.
    		bastionhost-cn-7mz28f5tk0o
    RegionIdstringNo

    The region ID of the bastion host to query.

    Note For more information about the mapping between region IDs and region names, see Regions and zones.
    		cn-hangzhou
    PageNumberstringNo

    The number of the page to return. Default value: 1.

    		1
    PageSizestringNo

    The number of entries per page. Valid values: 1 to100. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.

    Note We recommend that you do not leave this parameter empty.
    		20
    DatabaseTypestringNo

    The engine of the database to query. Valid values:

    • MySQL
    • Oracle
    • PostgreSQL
    • SQLServer
    		MySQL
    NetworkDomainIdstringNo

    The ID of the network domain where the database to query resides.

    		2
    SourcestringNo

    The type of the database to query. Valid values:

    • Local: on-premises database.
    • Rds: ApsaraDB for RDS instance.
    • PolarDB: PolarDB cluster
    		Local
    HostGroupIdstringNo

    The ID of the asset group to query. This operation returns the databases in the asset group.

    Note You can call the ListHostGroups operation to query the ID of the asset group.
    		20

    Response parameters

    ParameterTypeDescriptionExample
    object
    Databasesarray<object>

    The databases returned.

    itemobject
    ActiveAddressTypestring

    The address type of the database. Valid values:

    • Public
    • Private
    		Public
    Commentstring

    The remarks of the database.

    		comment
    DatabaseIdstring

    The database ID.

    		9
    DatabaseNamestring

    The name of the database.

    		MySQL0
    DatabasePortinteger

    The port of the database.

    		3306
    DatabasePrivateAddressstring

    The internal address of the database. The value is a domain name or an IP address.

    		rm-wz973w7******
    DatabasePublicAddressstring

    The public address of the database. The value is a domain name or an IP address.

    		rm-uf65n2******
    DatabaseTypestring

    The database engine. Valid values:

    • MySQL
    • Oracle
    • PostgreSQL
    • SQLServer
    		MySQL
    NetworkDomainIdstring

    The ID of the network domain where the database resides.

    		8
    Sourcestring

    The type of the database. Valid values:

    • Local: on-premises database.
    • Rds: ApsaraDB for RDS instance.
    • PolarDB: PolarDB cluster
    		Local
    SourceInstanceIdstring

    The ID of the ApsaraDB for RDS instance or PolarDB cluster.

    Note No value is returned for this parameter if Source is set to Local.
    		i-wz9ejupczf41******
    SourceInstanceRegionIdstring

    The region ID of the ApsaraDB for RDS instance or PolarDB cluster.

    		cn-hangzhou
    SourceInstanceStatestring

    The status of the database. Valid values:

    • Normal
    • Release
    		Normal
    RequestIdstring

    The request ID.

    		EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
    TotalCountlong

    The total number of databases returned.

    		4

    Examples

    Sample success responses

    JSONformat

    {
  "Databases": [
    {
      "ActiveAddressType": "Public",
      "Comment": "comment",
      "DatabaseId": "9",
      "DatabaseName": "MySQL0",
      "DatabasePort": 3306,
      "DatabasePrivateAddress": "rm-wz973w7******",
      "DatabasePublicAddress": "rm-uf65n2******",
      "DatabaseType": "MySQL",
      "NetworkDomainId": "8",
      "Source": "Local",
      "SourceInstanceId": "i-wz9ejupczf41******",
      "SourceInstanceRegionId": "cn-hangzhou",
      "SourceInstanceState": "Normal"
    }
  ],
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "TotalCount": 4
}

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidParameterThe argument is invalid.The argument is invalid.
    500InternalErrorAn unknown error occurred.An unknown error occurred.

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