tencent cloud

Feedback

DescribeDBInstanceAttribute

Last updated: 2022-07-08 10:18:50

1. API Description

Domain name for API request: postgres.tencentcloudapi.com.

This API is used to query the details of one instance.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeDBInstanceAttribute.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
DBInstanceId Yes String Instance ID

3. Output Parameters

Parameter Name Type Description
DBInstance DBInstance Instance details.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying instance details

Input Example

POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBInstanceAttribute
<Common request parameters>

{
    "DBInstanceId": "postgres-xxxxxxxx"
}

Output Example

{
  "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": "Unnamed",
      "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"
        }
      ]
    }
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure.UnauthorizedOperation Authentication failed.
FailedOperation.CamCheckResourceError Failed to get permissions. Please try again later. If the problem persists, please contact customer service.
FailedOperation.CamSigAndAuthError Authentication failed. Please try again later. If the problem persists, please contact customer service.
FailedOperation.DatabaseAccessError Failed to access database management service. Please try again later. If the problem persists, please contact customer service.
FailedOperation.FailedOperationError Operation failed. Please try again later.
FailedOperation.QueryInstanceBatchError Failed to query instance information in batches. Please try again later. If the problem persists, please contact customer service.
FailedOperation.QuerySpecBySpecCodeError Failed to query specifications.
InternalError.DBError Backend database execution error.
InternalError.InternalHttpServerError An exception occurred while executing the request.
InternalError.SystemError System error. When this error occurs, please contact customer service for assistance.
InternalError.UnknownError Unknown error. When this error occurs, please contact customer service for assistance.
InvalidParameter Parameter error.
InvalidParameterValue.IllegalRegion Invalid Region parameter.
InvalidParameterValue.IllegalZone Invalid Zone parameter.
InvalidParameterValue.InstanceNotExist The current instance does not exist.
InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
InvalidParameterValue.ParameterHandleError Failed to process the parameter. Please check if the parameter value is valid.
OperationDenied.CamDeniedError This operation cannot be performed.
ResourceNotFound.InstanceNotFoundError The instance does not exist.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support