调用GetDatabase API获取数据库详细信息-运维安全中心（堡垒机）-阿里云

获取指定数据库的详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-bastionhost:GetDatabase

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	指定要查询的数据库所在堡垒机的实例 ID。说明您可以调用 DescribeInstances 接口获取该参数。	bastionhost-cn-wwo36qbv601
RegionId	string	否	指定要查询的数据库所在堡垒机的区域 ID。说明区域 ID 和区域名称的对应关系，请参见地域和可用区。	cn-hangzhou
DatabaseId	string	是	需要查询的数据库 ID。说明您可以调用ListDatabases 接口获取该参数。	21

返回参数

名称	类型	描述	示例值
	object
Database	object	查询到的数据库实例详细信息。
ActiveAddressType	string	数据库实例地址类型。取值： Public ：公网地址 Private ：私网地址	Public
Comment	string	数据库实例备注。	comment
DatabaseId	string	数据库实例 ID。	22
DatabaseName	string	数据库实例名称。	test
DatabasePort	integer	数据库的端口。	3306
DatabasePrivateAddress	string	数据库实例的私网地址。	rm-bp1zq******
DatabasePublicAddress	string	数据库实例的公网地址。	rm-uf65******
DatabaseType	string	数据库类型。取值： mysql sqlserver postgresql oracle	MySQL
NetworkDomainId	string	数据库所属的网络域的 ID。	45
Source	string	指定新创建数据库实例的来源。取值： Local：本地数据库实例 Rds：RDS 类型数据库实例 PolarDB: PolarDB 类型数据库实例	Local
SourceInstanceId	string	数据库对应的 RDS 实例 ID 或 PolarDB 实例 ID。说明 Source 为 Local 时，该参数返回值为空。	i-wz9527ob0e0nftcsffke
SourceInstanceRegionId	string	数据库对应的 RDS 实例或 PolarDB 实例所在的区域 ID。	cn-hangzhou
SourceInstanceState	string	数据库实例状态。取值： Normal：正常 Release：已释放	Normal
RequestId	string	阿里云为该请求生成的唯一标识符。	4D72B883-9D15-5B05-B987-DFD10EB1FFB4

示例

正常返回示例

JSON格式

{
  "Database": {
    "ActiveAddressType": "Public",
    "Comment": "comment",
    "DatabaseId": "22",
    "DatabaseName": "test",
    "DatabasePort": 3306,
    "DatabasePrivateAddress": "rm-bp1zq******",
    "DatabasePublicAddress": "rm-uf65******",
    "DatabaseType": "MySQL",
    "NetworkDomainId": "45",
    "Source": "Local",
    "SourceInstanceId": "i-wz9527ob0e0nftcsffke",
    "SourceInstanceRegionId": "cn-hangzhou",
    "SourceInstanceState": "Normal"
  },
  "RequestId": "4D72B883-9D15-5B05-B987-DFD10EB1FFB4"
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	The argument is invalid.	参数错误
500	InternalError	An unknown error occurred.	未知错误
404	DatabaseNotFound	The database is not found.	数据库不存在

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。