检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Tok
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token获取请求认证接口说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud
表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:10 最大长度:32768 响应参数 状态码: 200
Token认证:通过Token认证调用请求,访问需求管理用户界面默认使用Token认证。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。推荐使用AK/SK认证,其安全性比Token认证要高。 关于认证鉴权的详细介绍及获取方式,请参见认证鉴权。
获取项目ID 调用API取项目ID 项目ID还用通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中“{Endpoint}”为IAM的终端节点,可以从终端节点获取。接口的认证鉴权请参见认证鉴权。
CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK");
API概览 表1 API概览 类型 说明 Scrum项目的工作项 Scrum项目工作项的创建、删除、修改、查询等相关接口。 Scrum项目的迭代 Scrum项目迭代的创建、删除、修改、查询等相关接口。 用户信息 获取当前用户信息,更新用户昵称,获取当前用户角色。 项目成员 添加、查询、删除、退出项目成员等接口信息。
表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:10 最大长度:32768 响应参数 状态码: 200
表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:10 最大长度:32768 响应参数 状态码: 200
参数解释:用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制:不涉及 取值范围:最小长度:10,最大长度:32768 默认取值:不涉及 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述
API Scrum项目的工作项 Scrum项目的迭代 用户信息 项目成员 项目信息 项目指标 项目统计 Scrum项目的模块 Scrum项目的领域 看板项目的工作项 Scrum项目的状态
完整的状态码列表请参见状态码。 对于获取用户Token获取请求认证接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于获取用户Token获取请求认证接口,返回如图1所示的消息头,其中“x-
获取指定工作项停留时间 功能介绍 获取指定工作项停留时间 调用方法 请参见如何调用API。 URI POST /v4/issues/duration 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。
参数解释:用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制:不涉及 取值范围:最小长度:10,最大长度:32768 默认取值:不涉及 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述
表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:10 最大长度:32768 响应参数 状态码: 200
获取当前用户信息 功能介绍 获取当前用户信息 调用方法 请参见如何调用API。 URI GET /v4/user 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Toke
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述
表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:10 最大长度:32768 响应参数 状态码: 200
示例1:获取需求管理中项目列表 场景描述 本章以用户test001为例,指导您通过API查询当前用户的项目列表。 API的调用方法请参见如何调用API。 约束限制 test001用户已经在需求管理中存在已自己创建的项目或参与的项目。 涉及接口 通过用户token查询当前用户项目信息。
表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:10 最大长度:32768 响应参数 状态码: 200