文档首页/ CodeArts IDE/ API参考/ API/ 激活管理/ 查询CodeArts IDE激活码列表
更新时间：2025-07-22 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询CodeArts IDE激活码列表

功能介绍

在激活码列表区域，查询已购买的CodeArts IDE激活码。

URI

GET /v2/licenses

表1 Query参数

参数

是否必选

参数类型

描述

id

否

String

参数解释：

唯一标识，购买激活码返回值中的激活码ID。

约束限制：

不涉及。

取值范围：

由数字、大小写英文字母和中划线（-）组成。

默认取值：

不涉及。

user_id

否

String

参数解释：

用户ID，即单击管理控制台右上角“我的凭证> API凭证”查询到的IAM用户ID。

约束限制：

不涉及。

取值范围：

由数字、大小写英文字母组成。

默认取值：

不涉及。

status

否

String

参数解释：

激活码状态。

约束限制：

不涉及。

取值范围：

  • FREEZE：表示激活码被冻结。
  • DELETED：表示激活码被删除。
  • NORMAL：表示激活码正常使用。
  • UNPAID：表示激活码未支付。

默认取值：

不涉及。

limit

否

Long

参数解释：

查询的消息条数。

约束限制：

不涉及。

取值范围：

[1~100]的整数。

默认取值：

15

offset

否

Long

参数解释：

偏移量。

约束限制：

不涉及。

取值范围：

最小值0

默认取值：

0

请求参数

无。

响应参数

状态码： 200

表2 响应Body参数

参数

参数类型

描述

result

result Object

参数解释：

查询激活码列表范围值，其中包括激活码数量和激活码信息

取值范围：

不涉及。

status

String

参数解释：

请求响应的状态，表明请求是否成功。

取值范围：

  • success：请求响应成功。
  • error：请求响应失败。
表3 result

参数

参数类型

描述

size

Long

参数解释：

每页显示的条目数量。

取值范围：

10、20、30

total_count

String

参数解释：

查询出的激活码总量。

取值范围：

0-100

iterms_before

Long

参数解释：

偏移量。

取值范围：

0-100

iterms

Array of LicenseV2Vo

参数解释：

激活码详情。

取值范围：

不涉及
表4 LicenseV2Vo

参数

参数类型

描述

id

String

参数解释：

激活码ID。

取值范围：

一段随机数，不涉及取值范围。

order_id

String

参数解释：

订单号。

取值范围：

一段随机数，不涉及取值范围。

creater_id

String

参数解释：

创建者用户id。

取值范围：

一段随机数，不涉及取值范围。

spec_code

String

参数解释：

规格SKU。

取值范围：

一段随机数，不涉及取值范围。

user_id

String

参数解释：

用户ID。

取值范围：

一段随机数，不涉及取值范围。

machine_code

String

参数解释：

使用者机器码。

取值范围：

一段随机数，不涉及取值范围。

status

String

参数解释：

激活码的状态码。

取值范围：
  • -1：表示激活码未支付。
  • 0： 表示激活码正常使用。
  • 1：表示激活码被冻结。
  • 2：表示激活码被删除。

charging_mode

String

参数解释：

付费模式。

取值范围：

prePaid

created_time

Date

参数解释：

创建时间。

取值范围：

1970年至今。

状态码： 403

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。详情请参见错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述信息。详情请参见错误码。

取值范围：

不涉及。

请求示例

查询当前用户购买的CodeArts IDE激活码列表。

GET https://{endpoint}/v2/licenses

响应示例

状态码：200

OK

{
  "result" : {
    "size" : 1,
    "total_items_count" : 1,
    "items_before" : 0,
    "items" : [ {
      "id" : "20d*****-****-****-****-*********e4w",
      "order_id" : "CS24012510353I6V5",
      "creater_id" : "0dc311a468024a...",
      "spec_code" : "codeartside.basic",
      "status" : 0,
      "charging_mode" : "prePaid",
      "created_time" : "2024-01-25T01:58:00Z"
    } ],
    "empty" : false
  },
  "status" : "success"
}

状态码：403

{    "error_code": "common.01010003",
     "error_msg": "No permissions for any one of the roles: [te_admin, readonly] ,or action"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 激活管理

相关文档