接口功能介绍
判断用户是否开通
接口约束
请保证账户余额大于0
URI
POST /userControl/isActivated
路径参数
无
Query参数
无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| hmac | 是 | String | kms鉴权值 | B1uAGreROOnfuQkNp9I5bE4aXsGwBcL5daW3W0nL0Mw= | |
| requestDate | 是 | String | 时间戳 | Wed, 29 Aug 2023 17:05:01 CST | |
| accessKey | 是 | String | ctapi鉴权ak | ae2cc5cc5e8211ea978a186590d96509 | |
| userId | 是 | String | 用户id | 562b89493b1a40e1b97ea05e50dd8170 | |
| regionId | 是 | Integer | 资源池id | fecnjniakfkn2314ndekqldedcsadfg |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| userId | 是 | String | 账号id，对应IT的accountId | 562b89493b1a40e1b97ea05e50dd8170 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| code | 是 | String | 返回码 取值范围：200 成功 | 200 | |
| errorCode | 是 | String | 错误码 | KMS.0514 | |
| msg | 是 | String | 调用结果信息 | 用户开通状态判断完成 | |
| data | 是 | Object | 接口返回结果 | returnObj |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| activated | 是 | String | 开通状态 true：开通 false：未开通 | true | |
| requestId | 是 | String | 请求id | a857cc58-ab6f-40ac-b9e7-fa1781209a76 |
请求示例
请求头header
{
"hmac": "B1uAGreROOnfuQkNp9I5bE4aXsGwBcL5daW3W0nL0Mw=",
"requestDate": "Wed, 29 Aug 2023 17:05:01 CST",
"accessKey": "ae2cc5cc5e8211ea978a186590d96509",
"userId":"562b89493b1a40e1b97ea05e50dd8170",
"regionId":"fecnjniakfkn2314ndekqldedcsadfg"
}请求体body
{
"userId":"562b89493b1a40e1b97ea05e50dd8170"
}响应示例
{
"code": "200",
"errorCode": null,
"msg": "开通状态判断完成",
"data": {
"activated": true,
"requestId":"a857cc58-ab6f-40ac-b9e7-fa1781209a76"
}
}状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
| 非200 | 表示请求异常。 |
错误码
请参考错误码说明。
