使用前必读
返回值
返回值 | 涵义 |
---|---|
| 操作成功 |
| 创建成功 |
| 参数错误,或是参数格式错误 |
| 认证失败 |
| 帐号并没有该操作的权限或者项目设置不允许该操作 |
| 资源不存在,也可能是帐号没有该项目的权限(为防止黑客撞库获取库列表) |
| 没有该接口 |
| 与已存在的对象/内容冲突或者操作行为与规则相冲突 |
| 操作不能进行 |
| 帐号被锁定,或api请求频率超限 |
| 请求被限流 |
| 服务器出错 |
开启 acces_token 认证
注:使用 API 并不是一定要开启 acces_token 认证。该认证是一种保证安全性的措施,建议开启。如不开启,可不携带 access_token 进行 API 请求。
开启认证,需要先修改配置文件,开启access_Token认证后才可以获取到口令,登录CI服务器,编辑配置文件 /data/bkce/etc/ci/common.yml 的 auth 段下的 accessToken 段的内容。
将enabled设为true,secret设为任意字符串string,expirationTime过期时间(毫秒)。
示例如下
修改后,需要重启相应的服务
认证方式
每个API调用都需要认证,请在query参数中携带access_Token,access_Token通过调用/ms/auth/api/user/token/get接口获取
accessToken 获取示例
浏览器访问 https://{域名}/ms/auth/api/user/token/get 获取
返回示例如下。
API请求示例
需添加 header 信息 X-DEVOPS-UID:用户名
最后更新于