tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeOrders

Last updated: 2024-06-17 14:25:48

    1. API Description

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

    This API is used to query the order information.

    A maximum of 1000 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: DescribeOrders.
    Version Yes String Common Params. The value used for this API: 2017-03-12.
    Region No String Common Params. This parameter is not required for this API.
    DealNames.N Yes Array of String Order name set

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of orders
    Deals Array of PgDeal Order array
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Querying the order information

    This example shows you how to query the order information.

    Input Example

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

{
    "DealNames": [
        "20180615110033"
    ]
}

    Output Example

    {
    "Response": {
        "Deals": [
            {
                "Count": 1,
                "OwnerUin": "909619400",
                "DBInstanceIdSet": [
                    "postgres-2uepfuz1"
                ],
                "PayMode": 1,
                "FlowId": 36,
                "DealName": "20180615110033"
            }
        ],
        "TotalCount": 1,
        "RequestId": "08fdf411-5d39-44f2-8e1d-a58ee60b237d"
    }
}

    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.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.QueryDealFailed Failed to query the order information.
    FailedOperation.TradeQueryOrderError Failed to query order information. Please try again later. If the problem persists, please contact customer service.
    InternalError.InternalHttpServerError An exception occurred while executing the request.
    InvalidParameter Parameter error.
    InvalidParameterValue.InstanceNotExist The current instance does not exist.
    InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
    InvalidParameterValue.NullDealNames Empty order name.
    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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy