开通或配置安全云脑订阅 - CreateSubscriptionOrder
功能介绍
安全云脑开通与配置接口
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/subscriptions/orders
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户项目ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
X-Language |
是 |
String |
用户当前语言环境 zh-cn or en-us. |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
scene |
是 |
String |
场景描述，执行包年包月(PREPAID)、按需(POSTPAID)开通，或者配置资源（CONFIG）用量，缺省值：PREPAID，大小写不敏感 |
|
promotion_info |
否 |
String |
促销折扣信息 String，JSON格式 |
|
operate_type |
是 |
String |
操作类型，比如创建场景为：CREATE、订单用量预警配置为：ALERT_CONFIG，大小写不敏感 |
|
tag_list |
否 |
Array of SubscriptionTag objects |
计费标签 |
|
product_list |
否 |
Array of Product objects |
当scene=PREPAID 或者 POSTPAID时，当前字段必填 商品列表 |
|
config |
否 |
OrderConfig object |
配置列表，当scene为CONFIG时必填 |
|
period_type |
否 |
Integer |
当scene=PREPAID时需要填写，订购周期类型： 2：月； 3：年； |
|
period_num |
否 |
Integer |
订购周期数，当scene=PREPAID时需要填写该值 取值大于0；小于等于0会报错。 当period_type=2时，其可选范围为[1, 9]，当period_type=3，其可选范围为[1, 3] |
|
is_auto_renew |
否 |
Integer |
当scene=PREPAID时，当前字段必填，是否自动续订，为空时表示不自动续订； 1：自动续订 0：不自动续订（默认） |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
key |
否 |
String |
键。 最大长度36个字符。 字符集：A-Z，a-z ， 0-9，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF） |
|
value |
否 |
String |
值。 最大长度43个字符，可以为空字符串。 字符集：A-Z，a-z ， 0-9，‘.’，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF） |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
resource_type |
是 |
String |
资源类型 |
|
resource_spec_code |
是 |
String |
资源规格编码 |
|
resource_size |
是 |
Integer |
订购数量 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
threshold_list |
否 |
Array of UsageThreshold objects |
阈值列表 |
|
alert_config |
否 |
AlertConfig object |
开启或关闭当前告警配置 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
order_id |
String |
创建或变更订单ID，只有scene为PREPAID时返回有此数据 |
|
order_status |
Integer |
订单更新状态，1：变更订单成功，5，订单变更失败 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码 取值范围: 不涉及 |
|
error_msg |
String |
参数解释: 错误描述 取值范围: 不涉及 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码 取值范围: 不涉及 |
|
error_msg |
String |
参数解释: 错误描述 取值范围: 不涉及 |
请求示例
-
POST https://{endpoint}/v1/{projectId}/subscriptions/orders { "period_num" : 1, "period_type" : 2, "is_auto_renew" : 1, "scene" : "PREPAID", "operate_type" : "CREATE", "product_list" : [ { "resource_type" : "xxx.resource.type.secmaster.typical", "resource_spec_code" : "secmaster.professional", "resource_size" : 3 } ], "tag_list" : [ { "key" : "testKey1", "value" : "testVal1" } ] } -
{ "scene" : "POSTPAID", "operate_type" : "CREATE", "product_list" : [ { "resource_type" : "xxx.resource.type.secmaster.typical", "resource_spec_code" : "secmaster.basic", "resource_size" : 3 } ], "tag_list" : [ { "key" : "testKey2", "value" : "testVal2" } ] }
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功 |
|
400 |
请求参数异常 |
|
403 |
权限不足 |
错误码
请参见错误码。
