有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

接口请求域名: cwp.tencentcloudapi.com 。

获取用户所有授权订单信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeLicenseList。
Version String 公共参数,本接口取值:2018-02-28。
Region String 公共参数,此参数为可选参数。
Filters.N Array of Filters 多个条件筛选时取交集
  • LicenseStatus 授权状态信息,0 未使用,1 部分使用, 2 已用完, 3 不可用 4 可使用
  • BuyTime 购买时间
  • LicenseType 授权类型, 0 专业版-按量计费, 1专业版-包年包月 , 2 旗舰版-包年包月
  • DeadlineStatus 到期状态 NotExpired 未过期, Expire 已过期(包含已销毁) NearExpiry 即将到期
  • ResourceId 资源ID
  • Keywords IP筛选
  • PayMode 付费模式 0 按量计费 , 1 包年包月
  • OrderStatus 订单状态 1 正常 2 隔离 3 销毁
  • DealNames 子订单号,最大长度10个,超出会失败

  • 示例值:[]
    Limit Integer 限制条数,默认10.
    示例值:10
    Offset Integer 偏移量,默认0.
    示例值:0
    Tags.N Array of Tags 标签筛选,平台标签能力,这里传入 标签键,标签值作为一个对象
    示例值:[]

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 总条数
    示例值:1
    List Array of LicenseDetail 授权数列表信息
    示例值:[]
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 示例

    输入示例

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

    输出示例

    {
        "Response": {
            "RequestId": "de41ce31-f2c0-49a9-a476-57051a5c7c6c",
            "TotalCount": 1,
            "List": [
                {
                    "LicenseId": 1,
                    "LicenseType": 0,
                    "LicenseStatus": 0,
                    "LicenseCnt": 0,
                    "UsedLicenseCnt": 0,
                    "OrderStatus": 1,
                    "BuyTime": "2018-02-28 00:00:00",
                    "Deadline": "2018-02-28 00:00:00",
                    "ResourceId": "1c007adc2f0bb9f7c052860e2d3703fa",
                    "AutoRenewFlag": 0,
                    "ProjectId": 1,
                    "TaskId": 1,
                    "SourceType": 0,
                    "Alias": "资源别名",
                    "Tags": [
                        {
                            "TagKey": "标签键",
                            "TagValue": "标签值"
                        }
                    ]
                }
            ]
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError 内部错误。
    InvalidParameter 参数错误。
    InvalidParameterValue 参数取值错误。