KMS service 接口文档 ​

KMS service 指的是 KMS 主工程的 service 服务，并不对 UI 界面开放，有独立的接口验证逻辑。调用前需要先创建一个 service token。

service token 是一组特殊的字符串，并需要添加到请求 header 中，作为调用方的身份验证之用。service token 包含两部分内容：

user 表示调用者的明文信息，仅仅支持小写字母和数字

tokenstring 是一串授权验证信息，在 KMS 服务端进行二次校验，校验方式跟 user 有关联

需要在 service api 的 header 中添加自定义 header 头如下

x-kms-user: user
x-kms-token: tokenstring

创建 serviceToken ​

打开 系统设置 - Service 授权管理 页面，在 “Service 用户名” 输入框输入 Service 用户名，点击输入框右侧的钥匙图标即可获取对应用户名的 SerivceToken 值。

/service/createExtendedProject ​

功能：从指定模板项目创建一个扩展项目

方法: POST

类型: application/json

参数如下：

成功响应如下

{
    "err": 0,    			 // 错误码，为 0 时表示正确
    "data": "yyyy-xxxx",	 // 返回内容，当操作成功后，返回新创建项目的完整 id
    "desc": ""	 			 // 错误信息，当 err 不为 0 时有效，返回具体的错误描述信息
}

错误码和释义如下

/service/updateExtendedProject ​

功能：从修改一个扩展项目的信息

方法: POST

类型: application/json

参数如下：

响应如下

{
    "err": 0,    // 错误码，为 0 时表示正确
    "data": "",	 // 返回内容，当操作成功后，返回新创建项目的完整 id
    "desc": ""	 // 错误信息，当 err 不为 0 时有效，返回具体的错误描述信息
}

错误码和释义如下

/service/readExtendedProjectRoles/:project ​

功能：查询指定扩展项目的角色列表

方法：GET

URL参数：:project 需要替换为实际的扩展项目的英文名，格式 yyyy-xxxx，比如 /service/readExtendedProjectRoles/abc-kgm

响应如下

{
    "err": 0,    // 错误码，为 0 时表示正确
    "desc": "",	 // 错误信息，当 err 不为 0 时有效，返回具体的错误描述信息
    "data": [    // 项目支持的角色列表 string[]
        "admin",
        ...
    ]
}

错误码和释义如下

/service/readExtendedProjectUsers/:project ​

功能：查询指定扩展项目的用户列表（以及对应的角色）

方法：GET

URL参数：:project 需要替换为实际的扩展项目的英文名，格式 yyyy-xxxx，比如 /service/readExtendedProjectUsers/abc-kgm

响应如下

{
    "err": 0,    // 错误码，为 0 时表示正确
    "desc": "",	 // 错误信息，当 err 不为 0 时有效，返回具体的错误描述信息
    "data": {    // 用户列表已经对应的角色（支持多个）
        "user1@kingsoft.com": ["admin"],
        "user2@kingsfot.com": ["运营", "主管"],
        ...
    }
}

错误码和释义如下

/service/addExtendedProjectUsers ​

功能：给指定扩展项目增加用户

方法：POST

URL参数：

响应如下

{
    "err": 0,    // 错误码，为 0 时表示正确
    "desc": "ok",
}

错误码和释义如下

/service/trigger/template/:id ​

功能：主动触发指定模板的渲染，将新增一个渲染任务到队列中，渲染将异步执行

方法: GET 或 POST

类型: application/json

URL参数：:id 需要替换成实际的模板id，比如 /service/trigger/template/pixh2

响应如下

{
    "err": 0,    // 错误码，为 0 时表示正确
    "desc": ""	 // 错误信息，当 err 不为 0 时有效，返回具体的错误描述信息
}

错误码和释义如下