1. 接口描述
接口请求域名: postgres.tencentcloudapi.com 。
接口(DescribeDatabases)用来查询实例的数据库列表。
默认接口请求频率限制:1000次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeDatabases。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
DBInstanceId | 是 | String | 实例ID 示例值:postgres-6bwgamo3 |
Filters.N | 否 | Array of Filter | 按照一个或者多个过滤条件进行查询,目前支持的过滤条件有:database-name:按照数据库名称过滤,类型为string。此处使用模糊匹配搜索符合条件的数据库。 示例值:[{"Name":"database-name","Values":["postgres"]}] |
Offset | 否 | Integer | 数据偏移量,从0开始。 示例值:0 |
Limit | 否 | Integer | 单次显示数量 示例值:20 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Items | Array of String | 数据库信息 示例值:["postgres","testdatabase"] |
TotalCount | Integer | 数据库总数 示例值:2 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取实例所有数据库
不做筛选,全量拉取实例的数据库列表。
输入示例
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDatabases
<公共请求参数>
{
"DBInstanceId": "postgres-hf8jo5pr"
}
输出示例
{
"Response": {
"Items": [
"postgres",
"postgres_bak_1715086333",
"postgres_bak_1715140150",
"rds",
"postgres_bak_1715152994"
],
"RequestId": "4045d7a9-5330-4c2c-b968-475570200a97",
"TotalCount": 5
}
}
示例2 获取实例部分数据库
使用筛选条件,返回部分数据库列表。
输入示例
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDatabases
<公共请求参数>
{
"DBInstanceId": "postgres-hf8jo5pr",
"Filters": [
{
"Name": "database-name",
"Values": [
"postgres"
]
}
],
"Offset": 1,
"Limit": 2
}
输出示例
{
"Response": {
"Items": [
"postgres_bak_1715086333",
"postgres_bak_1715140150"
],
"RequestId": "25cc2555-14a2-454f-af08-6bd691315335",
"TotalCount": 5
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure.UnauthorizedOperation | 鉴权失败。 |
DBError | 后台DB执行错误。 |
FailedOperation.CamSigAndAuthError | 鉴权失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
FailedOperation.DatabaseAccessError | 管控元数据库访问失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
FailedOperation.FailedOperationError | 操作失败,请稍后重试。 |
FailedOperation.LimitOperation | 实例被限制操作。 |
FailedOperation.OssAccessError | 访问管控服务失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
FailedOperation.PreCheckError | 操作预检查失败。 |
InternalError.DBError | 后台DB执行错误。 |
InternalError.InstanceDataError | 管控系统元数据访问异常,请联系客服处理。 |
InternalError.InternalHttpServerError | 请求执行异常。 |
InternalError.SystemError | 系统错误。出现这种错误时,请联系客服支持。 |
InvalidInstanceStatus | 实例状态错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.ParameterCheckError | 参数检查失败。 |
InvalidParameterValue.AccountNotExistError | 账号不存在。 |
InvalidParameterValue.IllegalRegion | 非法的Region参数。 |
InvalidParameterValue.InstanceNotExist | 当前实例不存在。 |
InvalidParameterValue.InvalidParameterValueError | 参数值有误。 |
InvalidParameterValue.ParameterHandleError | 参数处理失败,请检参数值设置是否有效。 |
OperationDenied.CamDeniedError | 当前操作被限制。 |
OperationDenied.InstanceAccessDeniedError | 您没有权限操作当前资源。 |
OperationDenied.InstanceStatusLimitOpError | 实例状态限制当前操作。 |
ResourceNotFound.InstanceNotFoundError | 实例不存在。 |
ResourceUnavailable.InvalidInstanceStatus | 实例状态错误。 |