调用GetDatabase获取具体库详情信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dms:GetDatabase | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Tid | long | 否 | 租户 ID。您可以通过调用 GetUserActiveTenant 接口获取该参数。 | -1 |
Host | string | 是 | 数据库连接地址。 | 192.168.XX.XX |
Port | integer | 是 | 数据库的连接端口。 | 3306 |
Sid | string | 否 | 数据库 Sid。 说明
数据库 Sid 是 Oracle 数据库的唯一标识符。当建立一个数据库时,系统将自动赋予一个初始 ID。
| test_sid |
SchemaName | string | 是 | 数据库名称。 | mysql |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "3CDB8601-AD74-4A47-8114-08E08CD6****",
"Database": {
"DatabaseId": "984****",
"Host": "192.168.XX.XX",
"CatalogName": "def",
"DbaName": "dba_name",
"State": "NORMAL",
"DbaId": "27****",
"SchemaName": "mysql",
"InstanceId": "149****",
"Port": 3306,
"EnvType": "product",
"Sid": "test_sid",
"OwnerIdList": {
"OwnerIds": [
"27****"
]
},
"Encoding": "utf8mb4",
"DbType": "mysql",
"OwnerNameList": {
"OwnerNames": [
"test"
]
},
"SearchName": "mysql@192.168.XX.XX:3306",
"InstanceAlias": "test"
},
"ErrorCode": "UnknownError",
"ErrorMessage": "An unknown error occurred.",
"Success": true
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-05-18 | OpenAPI 返回结构发生变更 | 查看变更详情 |