购买CA
功能介绍
购买CA。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v1/private-certificate-authorities/order
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:32 最大长度:2097152 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
cloud_service_type |
是 |
String |
云服务类型,固定为'hws.service.type.ccm' 最小长度:1 最大长度:64 |
charging_mode |
是 |
Integer |
计费模式 0包周期 |
period_type |
是 |
Integer |
订购周期 2月 3年 |
period_num |
是 |
Integer |
订购周期数 |
is_auto_renew |
是 |
Integer |
是否自动续费 1是 0否 |
promotion_info |
否 |
String |
折扣信息 最小长度:0 最大长度:2048 |
subscription_num |
是 |
Integer |
订购数量 |
is_auto_pay |
否 |
Integer |
是否自动支付 1是 0否 不填默认为0 |
enterprise_project_id |
否 |
String |
企业项目ID 最小长度:1 最大长度:64 |
product_infos |
是 |
Array of ProductInfo objects |
产品列表,详情请参见ProductInfo字段数据结构说明。 数组长度:0 - 10 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
order_id |
String |
订单号。 最小长度:1 最大长度:64 |
ca_ids |
Array of strings |
当前购买的CA证书ID列表。 最小长度:1 最大长度:64 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误请求返回的错误码。 最小长度:3 最大长度:36 |
error_msg |
String |
错误请求返回的错误信息。 最小长度:0 最大长度:1024 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误请求返回的错误码。 最小长度:3 最大长度:36 |
error_msg |
String |
错误请求返回的错误信息。 最小长度:0 最大长度:1024 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误请求返回的错误码。 最小长度:3 最大长度:36 |
error_msg |
String |
错误请求返回的错误信息。 最小长度:0 最大长度:1024 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误请求返回的错误码。 最小长度:3 最大长度:36 |
error_msg |
String |
错误请求返回的错误信息。 最小长度:0 最大长度:1024 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误请求返回的错误码。 最小长度:3 最大长度:36 |
error_msg |
String |
错误请求返回的错误信息。 最小长度:0 最大长度:1024 |
请求示例
创建CA订单,请求头中的X-Auth-Token字段需要填写token,且该token需要具有本API的访问权限。
POST https://{Endpoint}/v1/private-certificate-authorities/order { "cloud_service_type" : "hws.service.type.ccm", "period_type" : 2, "period_num" : 1, "charging_mode" : 0, "is_auto_renew" : 0, "is_auto_pay" : 0, "promotion_info" : "", "enterprise_project_id" : "0", "product_infos" : [ { "cloudServiceType" : "hws.service.type.ccm", "resourceType" : "hws.resource.type.pca.duration", "resourceSpecCode" : "ca.duration" } ], "subscription_num" : 1 }
响应示例
状态码: 200
请求已成功
{ "order_id" : "CS1803192259ROA8U", "ca_ids" : [ "4284547e-68ef-4a94-adea-9df1e5d8ad65", "211c079c-bab8-41af-8948-c5e2531232c6" ] }
状态码: 400
请求参数有误。
{ "error_code" : "PCA.XXX", "error_msg" : "XXX" }
状态码: 401
被请求的页面需要鉴权。
{ "error_code" : "PCA.XXX", "error_msg" : "XXX" }
状态码: 403
认证失败。
{ "error_code" : "PCA.XXX", "error_msg" : "XXX" }
状态码: 404
资源不存在或资源未找到。
{ "error_code" : "PCA.XXX", "error_msg" : "XXX" }
状态码: 500
服务内部错误。
{ "error_code" : "PCA.XXX", "error_msg" : "XXX" }
状态码
状态码 |
描述 |
---|---|
200 |
请求已成功 |
400 |
请求参数有误。 |
401 |
被请求的页面需要鉴权。 |
403 |
认证失败。 |
404 |
资源不存在或资源未找到。 |
500 |
服务内部错误。 |
错误码
请参见错误码。