DescribeResourcesByDealName

Last updated: 2021-08-05 17:35:34

1. API Description

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

This API is used to query the list of resources by billing order ID.

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 parameter. The value used for this API: DescribeResourcesByDealName.
Version Yes String Common parameter. The value used for this API: 2019-01-07.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
DealName Yes String Order ID. (If the cluster is not delivered yet, the DescribeResourcesByDealName API may return the InvalidParameterValue.DealNameNotFound error. Please call the API again until it succeeds.)

3. Output Parameters

Parameter Name Type Description
BillingResourceInfos Array of BillingResourceInfo Billable resource ID information array
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the information of resource associated with order ID

Input Example

https://cynosdb.tencentcloudapi.com/?Action=DescribeResourcesByDealName
&DealName=xxx
&<Common request parameters>

Output Example

{
  "Response": {
    "BillingResourceInfos": [
      {
        "ClusterId": "cynosdbmysql-r8ewihg4",
        "InstanceIds": [
          "cynosdbmysql-ins-pecl0drs"
        ]
      },
      {
        "ClusterId": "cynosdbmysql-hjosrxhu",
        "InstanceIds": [
          "cynosdbmysql-ins-7f59pahg"
        ]
      }
    ],
    "RequestId": "005b862f-f408-4a95-a7e7-26f3e672e081"
  }
}

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
FailedOperation.DatabaseAccessError Failed to access the database. Please try again later. If the problem persists, please contact customer service.
InternalError.DbOperationFailed Failed to query the database.
InternalError.SystemError Internal system error.
InvalidParameterValue.DealNameNotFound No order ID found.
InvalidParameterValue.ParamError Incorrect parameter.
UnauthorizedOperation.PermissionDenied CAM authentication failed.