# 查询缓存 - ListCacheData #### 功能介绍 查询缓存。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-projectman/projectman_api_1002.html)。 #### 授权信息 当前API调用无需身份策略权限。 #### URI POST /v3/job-cache/list-cache #### 请求参数 表1请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及。 **取值范围：** 长度为10\~32768个字符。 **默认取值：** 不涉及。 | 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | projectUUId | 否 | String | **参数解释**： 项目的32位uuid，项目唯一标识，通过[查询项目列表](https://support.huaweicloud.com/api-projectman/ListProjectsV4.html)接口获取，响应消息体中的**project_id**字段的值就是项目ID。 **约束限制**： 32位的数字和字母组成的字符串。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | type | 否 | String | **参数解释：** 字段类型。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： backlog。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | result | [result] object | **参数解释：** 查询缓存的返回结果。 | | status | String | **参数解释：** 查询缓存的返回状态。 **取值范围：** success：返回成功。 error：返回失败。 | 表4result | 参数 | 参数类型 | 描述 | |:---|:---|:---| | fields | Array of [FieldVO] objects | **参数解释：** 全部字段。 | | visibleFields | Array of [FieldVO] objects | **参数解释：** 表头显示字段。 | 表5FieldVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | trackerList | Array of integers | **参数解释**： 工作项类型数组。 **取值范围**： 2（任务/Task） 3（缺陷/Bug） 5（Epic） 6（Feature） 7（Story） | | name | String | **参数解释：** 字段名称。 **取值范围：** 不涉及。 | | field | String | **参数解释：** 字段code值。 **取值范围：** 不涉及。 | | isCustom | Boolean | **参数解释：** 是否自定义字段。 **取值范围：** true(是) false(不是) | | option | Array of [OptionVOV2] objects | **参数解释：** 字段选项。 **取值范围：** 不涉及。 | | option_source | String | **参数解释：** 字段值的来源范围。 **取值范围：** User 字段值可以是在项目空间中的所有成员 tag 标签 Status 状态 mportance 重要程度 Priority 优先级 Direct 字段值为根据数据类型 type 输入值 Text 字符串 | | type | String | **参数解释：** 字段类型。 **取值范围：** 不涉及。 | | required | Integer | **参数解释：** 字段是否必填。 **取值范围：** true（是） false（不是） | | fieldGroup | String | **参数解释：** 字段归属组。 **取值范围：** 不涉及。 | | sortable | Boolean | **参数解释：** 字段是否支持排序。 **取值范围：** true（是） false（不是） | | priorityOption | Array of [OptionVOV2] objects | **参数解释：** 优先级字段选项 | | severityOption | Array of [OptionVOV2] objects | **参数解释：** 严重程度字段选项 | | trackerOption | Array of [OptionVOV2] objects | **参数解释：** 工作项类型选项 | | doneRatioOption | Array of [OptionVOV2] objects | **参数解释：** 完成度字段选项 | 表6OptionVOV2 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 选项Id。 **取值范围：** 不涉及。 | | name | String | **参数解释：** 选项名称。 **取值范围：** 不涉及。 | #### 请求示例 ``` Post https://{endpoint}/v3/job-cache/list-cache { "projectUUId" : "381fcca9c056482d92da3e8b9da71db5", "type" : "backlog" } ``` #### 响应示例 **状态码：200** ``` { "result" : { "fields" : [ { "trackerList" : [ 1, 2, 3, 5, 6, 7 ], "name" : "编号", "field" : "id", "isCustom" : false, "type" : "number", "fieldGroup" : "basic", "sortable" : true, "priorityOption" : [ { "id" : "1", "name" : "低" }, { "id" : "2", "name" : "中" }, { "id" : "3", "name" : "高" } ], "severityOption" : [ { "id" : "10", "name" : "关键" }, { "id" : "11", "name" : "重要" }, { "id" : "12", "name" : "一般" }, { "id" : "13", "name" : "提示" } ], "trackerOption" : [ { "id" : "5", "name" : "Epic" }, { "id" : "6", "name" : "Feature" }, { "id" : "7", "name" : "Story" }, { "id" : "2", "name" : "Task" }, { "id" : "3", "name" : "Bug" } ], "doneRatioOption" : [ { "id" : "0", "name" : "0%" }, { "id" : "10", "name" : "10%" }, { "id" : "20", "name" : "20%" }, { "id" : "30", "name" : "30%" }, { "id" : "40", "name" : "40%" }, { "id" : "50", "name" : "50%" }, { "id" : "60", "name" : "60%" }, { "id" : "70", "name" : "70%" }, { "id" : "80", "name" : "80%" }, { "id" : "90", "name" : "90%" }, { "id" : "100", "name" : "100%" } ] }, { "trackerList" : [ 1, 2, 3, 5, 6, 7 ], "name" : "标题", "field" : "subject", "isCustom" : false, "type" : "text", "fieldGroup" : "basic", "sortable" : true, "priorityOption" : [ { "id" : "1", "name" : "低" }, { "id" : "2", "name" : "中" }, { "id" : "3", "name" : "高" } ], "severityOption" : [ { "id" : "10", "name" : "关键" }, { "id" : "11", "name" : "重要" }, { "id" : "12", "name" : "一般" }, { "id" : "13", "name" : "提示" } ], "trackerOption" : [ { "id" : "5", "name" : "Epic" }, { "id" : "6", "name" : "Feature" }, { "id" : "7", "name" : "Story" }, { "id" : "2", "name" : "Task" }, { "id" : "3", "name" : "Bug" } ], "doneRatioOption" : [ { "id" : "0", "name" : "0%" }, { "id" : "10", "name" : "10%" }, { "id" : "20", "name" : "20%" }, { "id" : "30", "name" : "30%" }, { "id" : "40", "name" : "40%" }, { "id" : "50", "name" : "50%" }, { "id" : "60", "name" : "60%" }, { "id" : "70", "name" : "70%" }, { "id" : "80", "name" : "80%" }, { "id" : "90", "name" : "90%" }, { "id" : "100", "name" : "100%" } ] } ], "visibleFields" : [ ] } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询缓存接口成功的响应。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-projectman/ErrorCode.html)。