1. 接口描述
接口请求域名: postgres.tencentcloudapi.com 。
本接口 (DescribeDBInstanceAttribute) 用于查询某个实例的详情信息。
默认接口请求频率限制:1000次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeDBInstanceAttribute。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
DBInstanceId | 是 | String | 实例ID 示例值:postgres-xxxxxxxx |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DBInstance | DBInstance | 实例详细信息。 示例值:{ "Region": "ap-guangzhou", "Zone": "ap-guangzhou-2", "AppId": 100000000, "Uid": 1000001, "ProjectId": 0, "VpcId": "vpc-xxxxxxxx", "SubnetId": "subnet-xxxxxxxx", "DBInstanceId": "postgres-xxxxxxxx", "MasterDBInstanceId": "postgres-xxxxxxxx", "Type": 1, "DBInstanceName": "未命名", "DBInstanceStatus": "running", "DBInstanceMemory": 4, "DBInstanceStorage": 20, "DBInstanceCpu": 2, "DBInstanceClass": "cdb.pg.z1.4g", "DBInstanceType": "primary", "DBInstanceVersion": "standard", "DBInstanceNetInfo": [ { "Address": "", "Ip": "10.10.10.220", "Port": 5432, "Status": "opened", "NetType": "private", "VpcId": "vpc-xxxxxxxx", "SubnetId": "subnet-xxxxxxxx" }, { "Address": "", "Ip": "", "Port": 0, "Status": "initing", "NetType": "public", "VpcId": "", "SubnetId": "" } ], "DBCharset": "UTF8", "IsSupportTDE": 0, "DBVersion": "10.4", "DBMajorVersion": "10", "DBKernelVersion": "v10.4_r1.0", "CreateTime": "2017-12-28 19:23:19", "UpdateTime": "2018-01-18 15:54:32", "ExpireTime": "2018-01-28 19:23:23", "IsolatedTime": "0000-00-00 00:00:00", "OfflineTime": "2019-12-28 19:23:19", "PayType": "prepaid", "AutoRenew": 1, "ReadOnlyInstanceNum": 1, "StatusInReadonlyGroup": "running", "SupportIpv6": 0, "TagList": [ { "TagKey": "tag1", "TagValue": "v1" } ], "NetworkAccessList": [], "DBNodeSet": [ { "Role": "Primary", "Zone": "ap-guangzhou-2" }, { "Role": "Standby", "Zone": "ap-guangzhou-3" } ] } |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询实例的详细信息
输入示例
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBInstanceAttribute
<公共请求参数>
{
"DBInstanceId": "postgres-xxxxxxxx"
}
输出示例
{
"Response": {
"RequestId": "08fdf411-5d39-44f2-8e1d-a58ee60b237d",
"DBInstance": {
"Region": "ap-guangzhou",
"Zone": "ap-guangzhou-2",
"AppId": 100000000,
"Uid": 1000001,
"ProjectId": 0,
"VpcId": "vpc-xxxxxxxx",
"SubnetId": "subnet-xxxxxxxx",
"DBInstanceId": "postgres-xxxxxxxx",
"MasterDBInstanceId": "postgres-xxxxxxxx",
"Type": "1",
"DBInstanceName": "未命名",
"DBInstanceStatus": "running",
"DBInstanceMemory": 4,
"DBInstanceStorage": 20,
"DBInstanceCpu": 2,
"DBInstanceClass": "cdb.pg.z1.4g",
"DBInstanceType": "primary",
"DBInstanceVersion": "standard",
"DBInstanceNetInfo": [
{
"Address": "",
"Ip": "10.10.10.220",
"Port": 5432,
"Status": "opened",
"NetType": "private",
"VpcId": "vpc-xxxxxxxx",
"SubnetId": "subnet-xxxxxxxx",
"ProtocolType": ""
},
{
"Address": "",
"Ip": "",
"Port": 0,
"Status": "initing",
"NetType": "public",
"VpcId": "",
"SubnetId": "",
"ProtocolType": ""
}
],
"DBCharset": "UTF8",
"IsSupportTDE": 0,
"DBVersion": "10.4",
"DBEngine": "postgresql",
"DBEngineConfig": "",
"DBMajorVersion": "10",
"DBKernelVersion": "v10.4_r1.0",
"CreateTime": "2017-12-28 19:23:19",
"UpdateTime": "2018-01-18 15:54:32",
"ExpireTime": "2018-01-28 19:23:23",
"IsolatedTime": "0000-00-00 00:00:00",
"OfflineTime": "2019-12-28 19:23:19",
"PayType": "prepaid",
"AutoRenew": 1,
"ReadOnlyInstanceNum": 1,
"StatusInReadonlyGroup": "running",
"SupportIpv6": 0,
"TagList": [
{
"TagKey": "tag1",
"TagValue": "v1"
}
],
"NetworkAccessList": [],
"DBNodeSet": [
{
"Role": "Primary",
"Zone": "ap-guangzhou-2",
"DedicatedClusterId": ""
},
{
"Role": "Standby",
"Zone": "ap-guangzhou-3",
"DedicatedClusterId": ""
}
]
}
}
}
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 | 鉴权失败。 |
FailedOperation.CamCheckResourceError | 获取权限失败,请稍后重试。如果持续不成功,请联系客服进行处理。。 |
FailedOperation.CamSigAndAuthError | 鉴权失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
FailedOperation.DatabaseAccessError | 管控元数据库访问失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
FailedOperation.DatabaseAffectedError | 数据操作失败,请联系客服进行处理。 |
FailedOperation.FailedOperationError | 操作失败,请稍后重试。 |
FailedOperation.QueryInstanceBatchError | 批量获取实例信息失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
FailedOperation.QuerySpecBySpecCodeError | 查询规格信息失败。 |
InternalError.DBError | 后台DB执行错误。 |
InternalError.InternalHttpServerError | 请求执行异常。 |
InternalError.SystemError | 系统错误。出现这种错误时,请联系客服支持。 |
InternalError.TransactioBeginError | 开启事务失败。 |
InternalError.UnknownError | 其他未知错误。出现这种错误时,请联系客服支持。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue.IllegalRegion | 非法的Region参数。 |
InvalidParameterValue.IllegalZone | 非法的Zone参数。 |
InvalidParameterValue.InstanceNotExist | 当前实例不存在。 |
InvalidParameterValue.InvalidParameterValueError | 参数值有误。 |
InvalidParameterValue.ParameterHandleError | 参数处理失败,请检参数值设置是否有效。 |
OperationDenied.CamDeniedError | 当前操作被限制。 |
ResourceNotFound.InstanceNotFoundError | 实例不存在。 |