1. 接口描述
接口请求域名： postgres.tencentcloudapi.com 。
用于查询一个或多个serverlessDB实例的详细信息
默认接口请求频率限制：1000次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeServerlessDBInstances。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Filter.N | 否 | Array of Filter | 查询条件 |
| Limit | 否 | Integer | 查询个数 示例值：20 |
| Offset | 否 | Integer | 偏移量 示例值：1 |
| OrderBy | 否 | String | 排序指标，目前支持实例创建时间CreateTime |
| OrderByType | 否 | String | 排序方式，包括升序、降序 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 查询结果数 示例值：1 |
| DBInstanceSet | Array of ServerlessDBInstance | 查询结果 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询ServerlessDB实例列表
输入示例
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeServerlessDBInstances
<公共请求参数>
{
"Filter": [
{
"Name": "\"xxx\","
}
],
"Limit": "0",
"Offset": "1"
}输出示例
{
"Response": {
"TotalCount": 1,
"DBInstanceSet": [
{
"DBInstanceId": "postgres-xxxxxxxx",
"DBInstanceName": "xxx",
"DBInstanceStatus": "running",
"Region": "ap-guangzhou",
"Zone": "ap-guangzhou-3",
"ProjectId": 0,
"VpcId": "vpc-xxxxxxxx",
"SubnetId": "subnet-xxxxxxxx",
"DBCharset": "UTF8",
"DBVersion": "10",
"DBKernelVersion": "v10.4_r1.0",
"CreateTime": "2020-03-20 12:19:14",
"DBInstanceNetInfo": [
{
"Address": "",
"Ip": "10.10.10.111",
"Port": 5432,
"Status": "opened",
"NetType": "private"
},
{
"Address": "",
"Ip": "",
"Port": 0,
"Status": "initing",
"NetType": "public"
}
],
"DBAccountSet": [],
"DBDatabaseList": null
}
],
"RequestId": "d43b2a9f-070c-480b-a0bb-7c210428cfe8"
}
}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.CamAuthFailed | CAM鉴权失败。 |
| FailedOperation.CamCheckResourceError | 获取权限失败，请稍后重试。如果持续不成功，请联系客服进行处理。。 |
| FailedOperation.CamSigAndAuthError | 鉴权失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| FailedOperation.DatabaseAccessError | 管控元数据库访问失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| FailedOperation.DatabaseAffectedError | 数据操作失败，请联系客服进行处理。 |
| FailedOperation.FailedOperationError | 操作失败，请稍后重试。 |
| InterfaceNameNotFound | ACTION输入错误。 |
| InternalError | 内部错误。 |
| InternalError.DBError | 后台DB执行错误。 |
| InternalError.InternalHttpServerError | 请求执行异常。 |
| InternalError.SystemError | 系统错误。出现这种错误时，请联系客服支持。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.VpcNotFoundError | 未获取到VPC信息。 |
| InvalidParameterValue.DataConvertError | 数据格式转换失败，请联系客服处理。 |
| InvalidParameterValue.IllegalProjectId | 非法ProjectId。 |
| InvalidParameterValue.IllegalRegion | 非法的Region参数。 |
| InvalidParameterValue.InstanceNotExist | 当前实例不存在。 |
| InvalidParameterValue.InvalidParameterValueError | 参数值有误。 |
| InvalidParameterValue.ParameterHandleError | 参数处理失败，请检参数值设置是否有效。 |
| OperationDenied.CamDeniedError | 当前操作被限制。 |
| ResourceNotFound.InstanceNotFoundError | 实例不存在。 |
| ResourceUnavailable.VpcResourceNotFound | 没有找到实例所属VPC信息。 |
| StructParseFailed | 解析参数出错。 |
| SystemError | 系统错误。出现这种错误时，请联系客服支持。 |
| UnknownError | 其他未知错误。出现这种错误时，请联系客服支持。 |
| UnsupportedOperation | 操作不支持。 |