流水线 CodeArts Pipeline
流水线 CodeArts Pipeline
- 最新动态
- 功能总览
- 产品介绍
- 快速入门
- 用户指南
- 最佳实践
-
API参考
- 使用前必读
- API概览
- 如何调用API
-
API
- 模板管理
-
流水线管理
- 启动流水线
- 批量获取流水线状态
- 获取流水线状态/获取流水线执行详情
- 获取流水线列表/获取项目下流水线执行状况
- 删除流水线
- 查询流水线详情
- 修改流水线信息
- 停止流水线
- 获取流水线执行记录
- 基于模板创建流水线
- 创建流水线
- 重试运行流水线
- 通过人工审核
- 获取流水线运行需要的自定义参数
- 驳回人工审核
- 查询流水线日志
- 获取流水线步骤执行输出
- 查询流水线上的构建产物
- 批量删除流水线
- 禁用流水线
- 批量设置流水线标签
- 启用流水线
- 批量运行流水线
- 查询流水线任务日志
- 延时任务通过
- 延时任务拒绝
- 延时1小时
- 手动卡点通过
- 手动卡点拒绝
- 解除挂起
- 查询批量执行流水线结果
- 交换分组顺序
- 流水线官方消息通知查询
- 流水线官方消息通知更新
- 流水线消息通知开关
- 流水线第三方消息通知查询
- 流水线第三方消息通知更新
- 查询流水线的角色权限
- 查询流水线的用户权限
- 修改流水线的角色权限
- 修改流水线的用户权限
- 查询流水线是否启用二级权限
- 修改流水线是否启用二级权限
- 批量设置流水线实例二级权限
- 取消某次流水线排队
- 查询当前流水线排队中的记录
- 查询流水线的旧版运行记录
- 查询流水线运行使用的参数
- 回退执行流水线
- 获取step跳转链接
- 查询流水线运行的变更
- 查询流水线可用的系统参数
- 查询流水线触发失败记录
- 查询流水线修改历史
- 创建参数组
- 修改参数组
- 删除参数组
- 流水线绑定参数组
- 查询参数组详情
- 查询流水线关联的参数组
- 查询参数组列表
- 获取通用Webhook信息
- 分组管理
- 规则管理
- 租户级策略管理
- 项目级策略管理
- 扩展插件管理
- 扩展点管理
- 流水线标签管理
- 变更管理
- 微服务管理
- 模板管理（旧版，待下线）
- 流水线管理（旧版，待下线）
- 应用示例
- 附录
- 文档修订记录
- 场景代码示例
- 常见问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功！
认证鉴权
调用接口有如下两种认证方式，您可以选择其中一种进行认证鉴权。
- Token认证：通过Token认证通用请求。
- AK/SK认证：通过AK（Access Key ID）/SK（Secret Access Key)加密调用请求。
Token认证
说明：
- Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。
- 使用Token前请确保Token离过期有足够的时间，防止调用API的过程中Token过期导致调用API失败。
Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。
Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。
{
"auth": {
"identity": {
"methods": [
"password"
],
"password": {
"user": {
"name": "username",
"password": "********",
"domain": {
"name": "domainname"
}
}
}
},
"scope": {
"project": {
"name": "xxxxxxxx"
}
}
}
}获取Token后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。
GET https://iam.cn-north-1.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Auth-Token: ABCDEFJ....
您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333 。
AK/SK认证
说明：
- AK/SK签名认证方式仅支持请求Body体大小12M以内，12M以上的请求请使用Token认证。
- AK/SK既可以使用永久访问密钥中的AK/SK，也可以使用临时访问密钥中的AK/SK，但使用临时访问密钥的AK/SK时需要额外携带“X-Security-Token”字段，字段值为临时访问密钥的security_token。
AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。
- AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。
- SK(Secret Access Key)：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。
使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。
须知：
签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。
您也可以通过这个视频教程了解AK/SK认证的使用：https://bbs.huaweicloud.com/videos/100697 。
父主题： 如何调用API
