TDSQL-C MySQL 版查询资源包列表-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： cynosdb.tencentcloudapi.com 。

本接口（DescribeResourcePackageList）用于查询资源包列表。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeResourcePackageList。
Version	是	String	公共参数，本接口取值：2019-01-07。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley 。
PackageId.N	否	Array of String	资源包唯一ID
PackageName.N	否	Array of String	资源包名称
PackageType.N	否	Array of String	资源包类型 CCU-计算资源包，DISK-存储资源包
PackageRegion.N	否	Array of String	资源包使用地域 china-中国内地通用，overseas-港澳台及海外通用
Status.N	否	Array of String	资源包状态 creating-创建中； using-使用中； expired-已过期； normal_finish-使用完； apply_refund-申请退费中； refund-已退费。
OrderBy.N	否	Array of String	排序条件，支持排序条件:startTime-生效时间， expireTime-过期时间，packageUsedSpec-使用容量，packageTotalSpec-总存储量。按照数组顺序排列；
OrderDirection	否	String	排序方式，DESC-降序，ASC-升序
Offset	否	Integer	偏移量
Limit	否	Integer	限制

3. 输出参数

参数名称	类型	描述
Total	Integer	资源包总数示例值：10
Detail	Array of Package	资源包明细注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询资源包列表

查询资源包列表

输入示例

POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSourcePackageList
<公共请求参数>

{
    "PackageId": [
        "package-bst68sh3"
    ],
    "PackageName": [
        "自定义资源包名称-1"
    ],
    "PackageType": [
        "CCU"
    ],
    "PackageRegion": [
        "chineseMainland"
    ],
    "Status": [
        "using"
    ],
    "OrderBy": [
        "createTime"
    ],
    "OrderDirection": "desc",
    "Offset": 0,
    "Limit": 20
}

输出示例

{
    "Response": {
        "Total": 20,
        "Detail": [
            {
                "AppId": 12387234,
                "PackageId": "package-cbhsyegx",
                "PackageName": "MyPackageName",
                "PackageType": "CCU",
                "PackageRegion": "chineseMainland",
                "Status": "using",
                "PackageTotalSpec": 10000000,
                "PackageUsedSpec": 2394.3,
                "HasQuota": true,
                "BindInstanceInfos": [
                    {
                        "InstanceId": "cynosdbpg-ins-bzkxxrmt",
                        "InstanceRegion": "ap-guangzhou",
                        "InstanceType": "cynosdb-serverless"
                    }
                ],
                "StartTime": "2023-12-10 00:00:00",
                "ExpireTime": "2025-11-10 00:00:00"
            }
        ],
        "RequestId": "e0c28bb4-a0f2-4194-a646-b8bcf777b5ce"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.DatabaseAccessError	数据库访问失败，请稍后重试。如果持续不成功，请联系客服进行处理。
FailedOperation.QuerySourcePackageError	查询资源包失败
InternalError.DbOperationFailed	查询数据库失败。
InternalError.SystemError	系统内部错误。
InvalidParameterValue.InvalidParameterValueError	参数值无效。
UnauthorizedOperation.PermissionDenied	CAM鉴权不通过。