文档首页/ CodeArts IDE/ API参考/ API/ 激活管理/ 购买CodeArts IDE激活码
更新时间:2025-07-08 GMT+08:00
分享

购买CodeArts IDE激活码

功能介绍

登录CodeArts IDE客户端,购买激活码并绑定用户。

URI

POST /v2/licenses

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

spec_code

String

参数解释:

规格(SKU):购买的产品规格。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

codeartside.basic。

charging_mode

String

参数解释:

CodeArts IDE激活码的计费模式。

约束限制:

不涉及。

取值范围:

仅支持“prePaid”,包周期计费模式。

默认取值:

prePaid

period_type

String

参数解释:

包周期计费的单位,周期类型如年、月。

约束限制:

不涉及。

取值范围:

仅支持“month”,按月包周期计费模式。

默认取值:

month

period_num

Integer

参数解释:

续费变更的周期数。

约束限制:

不涉及。

取值范围:

仅支持“1”。

默认取值:

1

is_auto_renew

Boolean

参数解释:

包周期的资源是否开通自动续费,非包周期资源为空。

约束限制:

不涉及。

取值范围:

  • true:开通自动续费功能。
  • false:不开通自动续费功能。

默认取值:

false

is_auto_pay

Boolean

参数解释:

是否自动支付费用。

约束限制:

不涉及。

取值范围:

  • true:自动支付费用。
  • false:不自动支付费用。

默认取值:

false

count

Integer

参数解释:

购买的激活码资源总数。

约束限制:

不涉及。

取值范围:

[1~10]的整数。

默认取值:

1

is_auto_bind

Boolean

参数解释:

激活码是否自动绑定用户。

约束限制:

不涉及。

取值范围:

  • true:自动绑定当前用户。
  • false:不绑定任何用户。

默认取值:

false

响应参数

状态码: 200

表2 响应Body参数

参数

参数类型

描述

result

result Object

参数解释:

返回订单ID和申请的激活码列表。

取值范围:

不涉及。

status

String

参数解释:

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

取值范围:

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

参数

参数类型

描述

order_id

String

参数解释:

返回订单ID。

取值范围:

不涉及。

license_ids

Array

参数解释:

购买的激活码列表。

取值范围:

不涉及。

状态码: 403

表4 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

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

取值范围:

不涉及。

error_msg

String

参数解释:

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

取值范围:

不涉及。

请求示例

购买1个基本规格的按月包周期计费,不开通自动续费和自动付款,且不绑定用户的CodeArts IDE激活码。

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

{
  "spec_code" : "codeartside.basic",
  "charging_mode" : "prePaid",
  "period_type" : "month",
  "period_num" : 1,
  "is_auto_renew" : false,
  "is_auto_pay" : false,
  "count" : 1,
  "is_auto_bind" : false
}

响应示例

状态码: 200

{
  "result" : {
    "order_id" : "CS24012510353I6V5",
    "license_ids" : [ "20d*****-****-****-****-*********e4w" ]
  },
  "status" : "success"
}

状态码: 403

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

状态码

请参见状态码

错误码

请参见错误码

相关文档