华为云用户手册

  • URI POST /v4/projects/{project_id}/member 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目的32位uuid,项目唯一标识,通过[查询项目列表]接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 正则表达式,[A-Za-z0-9]{32}。 取值范围: 不涉及 默认取值: 不涉及。
  • 响应示例 状态码:200 { "issues" : [ { "subject" : "demo", "issue_id" : 1234, "project" : { "project_name" : "demo", "project_id" : "58d9050550c847c89885c1797a718b0c" }, "user" : { "user_num_id" : 4091, "user_id" : "a360371833bf4c558f796fd707b44daf", "user_name" : "demo_user_name_xiongzhitest001", "nick_name" : "bear" }, "status" : { "id" : "1", "name" : "未开始" } } ], "total" : 12 }
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 issues Array of AssociateIssueDetail objects 参数解释: 关联的工作项列表 total Integer 参数解释: 关联工作项总数 取值范围: 不涉及 表5 AssociateIssueDetail 参数 参数类型 描述 issue_id Integer 参数解释: 工作项ID 取值范围: 不涉及 project SimpleProject object 参数解释: 项目信息 status StatusVo object 参数解释: 工作项状态信息 取值范围: 不涉及 subject String 参数解释: 工作项标题 取值范围: 不涉及 user SimpleUser object 参数解释: 用户信息 表6 SimpleProject 参数 参数类型 描述 project_id String 参数解释: 项目的32位uuid,项目唯一标识,通过[查询项目列表]接口获取,响应消息体中的project_id字段的值就是项目ID 约束限制: 正则表达式,[A-Za-z0-9]{32}。 默认取值: 不涉及 project_name String 参数解释: 项目名称 取值范围: 不涉及 表7 StatusVo 参数 参数类型 描述 id String 参数解释: 状态id 取值范围: 不涉及 name String 参数解释: 状态id对应的值 取值范围: 不涉及 表8 SimpleUser 参数 参数类型 描述 nick_name String 参数解释: 用户昵称,可通过[获取指定项目的成员用户列表]接口获取指定项目的成员用户列表中nick_name字段 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 user_id String 参数解释: 用户uuid,可通过[获取指定项目的成员用户列表]接口获取指定项目的成员用户列表中user_id字段 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 user_name String 参数解释: 账号名,可通过[获取指定项目的成员用户列表]接口获取指定项目的成员用户列表中user_name字段 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 user_num_id Integer 参数解释: 用户数字id,可通过[获取指定项目的成员用户列表]接口获取指定项目的成员用户列表中user_num_id字段 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 状态码:400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码:401 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • URI GET /v4/projects/{project_id}/issues/{issue_id}/associated-issues 表1 路径参数 参数 是否必选 参数类型 描述 issue_id 是 Integer 参数解释: 工作项id,可通过[高级查询工作项]接口获取,响应消息体中的id字段的值就是工作项id。 约束限制: 正则表达式,[0-9]{1,10}。 取值范围: 最小长度:1,最大长度:10 默认取值: 不涉及 project_id 是 String 参数解释: 项目的32位uuid,项目唯一标识,通过[查询项目列表]接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 正则表达式,[A-Za-z0-9]{32}。 取值范围: 不涉及 默认取值: 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 limit 是 Integer 参数解释: 条数,每页显示查询的数量。 约束限制: 不涉及。 取值范围: 最小值:1,最大值:1000。 默认取值: 10 offset 是 Integer 参数解释: 分页索引,偏移量,offset是limit的整数倍数。 约束限制: 从0开始。 取值范围: 最小值:0,最大值:10000。 默认取值: 缺省值:0
  • 响应示例 状态码:200 OK { "work_items" : [ { "id" : "4633454879781163008", "description" : "demo", "actual_work_hours" : 10, "assigned_user" : { "id" : "665b542eb4c14b53a15ead449f28b0ba", "name" : "demo_user_name", "nick_name" : "demo" }, "author" : { "id" : "665b542eb4c14b53a15ead449f28b0ba", "name" : "demo_user_name", "nick_name" : "demo" }, "begin_time" : "1590940800000", "created_time" : "1590940800000", "tags" : [ { "id" : "456", "name" : "tagdemo" } ], "developer" : { "id" : "665b542eb4c14b53a15ead449f28b0ba", "name" : "demo_user_name", "nick_name" : "demo" }, "assigned_cc_user" : [ { "id" : "665b542eb4c14b53a15ead449f28b0ba", "name" : "demo_user_name", "nick_name" : "demo" } ], "discover_version" : "ProjectMan 8.0.0", "end_time" : "1590940800000", "done_ratio" : "10%", "expected_work_hours" : 9, "order" : "1", "parent_work_item_id" : "4633454879781163001", "release_version" : "ProjectMan 8.0.0", "story_point" : "0", "domain" : { "id" : "14", "name" : "性能" }, "iteration" : { "id" : "456", "name" : "迭代1" }, "module" : { "id" : "456", "name" : "Project" }, "priority" : "低", "severity" : "一般", "status" : { "id" : "d25fe91f7f6b489db5f804e66ac3b360", "name" : "新建" }, "subject" : "demosubject", "updated_time" : "1595832054113", "sequence" : "5500756", "important" : "提示", "custom_fields" : [ { "field_id" : "d25fe91f7f6b489db5f804e66a0", "field_name" : "customField", "field_type" : "Select", "field_option_source" : "USER", "value" : "{\"id\":\"d25fe91f7f6b489db5f804e66a0\",\"name\":\"devcloud_test001\",\"nick_name\":\"demo\"}" } ] } ], "total" : 1 }
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 total Integer 参数解释: 查询看板下工作项总数 取值范围: 不涉及 work_items Array of Workitems objects 参数解释: 工作项信息 表4 Workitems 参数 参数类型 描述 actual_work_hours Double 参数解释: 实际工时 取值范围: 最小值:0 assigned_cc_user Array of WorkitemUser objects 参数解释: 抄送人 assigned_user WorkitemUser object 参数解释: 处理人 author WorkitemUser object 参数解释: 创建人 begin_time String 参数解释: 工作项开始时间,unix时间戳,单位:毫秒,样例:1590940800000 取值范围: 不涉及 created_time String 参数解释: 创建时间,unix时间戳,单位:毫秒,样例:1590940800000 取值范围: 不涉及 custom_fields Array of WorkitemCustomField objects 参数解释: 用户自定义字段 description String 参数解释: 工作项描述 取值范围: 不涉及 developer WorkitemUser object 参数解释: 开发人员 discover_version String 参数解释: 发现问题的版本 取值范围: 不涉及 domain domain object 参数解释: 领域 done_ratio String 参数解释: 工作项完成度 ,如20,表示完成度为20% 取值范围: 最小值 0 最大值 100 end_time String 参数解释: 工作项结束时间,unix时间戳,单位:毫秒,样例:1590940800000 取值范围: 不涉及 expected_work_hours Double 参数解释: 预计工时 取值范围: 最小值:0 id String 参数解释: 工作项id 取值范围: 0至9999999999 important String 参数解释: 重要程度 "关键", "重要", "一般", "提示" 取值范围: 关键,重要,一般,提示 iteration iteration object 参数解释: 迭代 module module object 参数解释: 模块 order String 参数解释: 顺序 取值范围: 不涉及 parent_work_item_id String 父工作项的id 取值范围: 不涉及 priority String 参数解释: 工作项优先级 取值范围: 不涉及 release_version String 参数解释: 发布的版本 取值范围: 不涉及 sequence String 参数解释: 工作项编号 取值范围: 不涉及 severity String 参数解释: 严重的程度 "提示", "一般", "严重", "致命" 取值范围: 提示,一般,严重,致命 status status object 参数解释: 工作项状态 story_point String 参数解释: 故事点 取值范围: 不涉及 subject String 参数解释: 工作项标题 取值范围: 不涉及 tags Array of tags objects 参数解释: 标签 updated_time String 参数解释: 更新时间,unix时间戳,单位:毫秒,样例:1590940800000 取值范围: 不涉及 表5 WorkitemUser 参数 参数类型 描述 id String 参数解释: 用户32位uuid 取值范围: 不涉及 name String 参数解释: 用户名 取值范围: 不涉及 nick_name String 参数解释: 用户昵称 取值范围: 不涉及**** 表6 WorkitemCustomField 参数 参数类型 描述 field_id String 参数解释: 自定义字段id 取值范围: 不涉及 field_name String 参数解释: 自定义字段名称 取值范围: 不涉及 field_option_source String 参数解释: 自定义字段的选项源,枚举: CUSTOM USER DOMAIN ITERATION MODULE TAG 取值范围: CUSTOM,USER,DOMAIN,ITERATION,MODULE,TAG field_type String 参数解释: 自定义字段类型,枚举: Date Number DateTime MultiLineText SingleLineText Select Checkbox 取值范围: Date,Number,DateTime,MultiLineText,SingleLineText,Select,Checkbox value String 参数解释: 自定义字段值 (field_type为Date,Number,DateTime时,field_option_source为空,value值是数字的字符串), (field_type为MultiLineText,SingleLineText时,field_option_source为空,value值是文本字符串), (field_type为Select,field_option_source为CUSTOM时,value值是文本字符串), (field_type为Select ,field_option_source为USER,DOMAIN,ITERATION,MODULE,TAG时,value值是Json格式{}), (field_type为Checkbox ,field_option_source为CUSTOM时,value值是字符串数组["aaa"]), (field_type为"Checkbox",field_option_source为USER,DOMAIN,ITERATION,MODULE,TAG时,value值是Json的数组[{},{}])。 取值范围: 不涉及 表7 domain 参数 参数类型 描述 id String 参数解释: 领域id: 枚举: 14(性能) 15(功能) 16('可靠性) 17(网络安全) 18(可维护性) 19(其他DFX) 20(可用性) 取值范围: 14,15,16,17,18,19,20 name String 参数解释: 领 域名 称 取值范围: 不涉及 表8 iteration 参数 参数类型 描述 id String 参数解释: 迭代id 取值范围: 最小值:0 name String 参数解释: 迭代名 取值范围: 不涉及 表9 module 参数 参数类型 描述 id String 参数解释: 模块id 取值范围: 最小值:0 name String 参数解释: 模块 取值范围: 不涉及 表10 status 参数 参数类型 描述 id String 参数解释: 状态id,枚举: 1(新建) 2(进行中) 3(已解决) 4(测试中) 5( 已关闭) 6(已拒绝) 取值范围: 1,2,3,4,5,6 name String 参数解释: 状态名称 取值范围: 不涉及 表11 tags 参数 参数类型 描述 id String 参数解释: 标签id 取值范围: 不涉及 name String 参数解释: 标签名称 取值范围: 不涉及 状态码:400 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码:401 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • URI GET /v4/projects/{project_id}/work-items 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目的32位uuid,项目唯一标识,通过[查询项目列表]接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 正则表达式,[A-Za-z0-9]{32}。 取值范围: 不涉及 默认取值: 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 参数解释: 分页索引,偏移量,offset是limit的整数倍数 约束限制: 正则表达式,0|[1-9]\d{0,10}。 取值范围: 最小值:0 默认取值: 0 limit 否 Integer 参数解释: 每页显示查询看板下工作项的数量 约束限制: 不涉及 取值范围: 最小值:1 最大值:100 默认取值: 100 created_time_interval 否 String 参数解释: 根据工作项的创建时间查询工作项(查询的起始时间,查询的结束时间),unix时间戳,单位:毫秒 样例:1576114296000,1576114396000 约束限制: 正则表达式,([1-9][0-9]{0,12})?(,)?([1-9][0-9]{0,12})?。 取值范围: 不涉及 默认取值: 不涉及
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 templates Array of templates objects 参数解释: 模板信息列表。 表5 templates 参数 参数类型 描述 id Integer 参数解释: 模板id。 取值范围: 不涉及。 project_id Integer 参数解释: 项目id。 取值范围: 不涉及。 tracker_id Integer 参数解释: 工作项类型id。 取值范围: 2(任务/Task) 3(缺陷/Bug) 5(Epic) 6(Feature) 7(Story) description String 参数解释: 工作项详情模板描述内容。 取值范围: 最小长度:0,最大长度:65535。 issue_field_config String 参数解释: 模板配置。 取值范围: 不涉及。 状态码:400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码:401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • URI GET /v4/projects/{project_id}/templates 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目的32位uuid,项目唯一标识,通过[查询项目列表]接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 正则表达式,[A-Za-z0-9]{32}。 取值范围: 不涉及 默认取值: 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 tracker_id 否 String 参数解释: 工作项类型id 约束限制: 2(任务/Task) 3(缺陷/Bug) 5(Epic) 6(Feature) 7(Story) 取值范围: 最小值2,最大值7 默认取值: 不涉及
  • URI GET /v4/projects/{project_id}/issues/{issue_id}/attachments/{attachment_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目的32位uuid,项目唯一标识,通过[查询项目列表]接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 正则表达式,[A-Za-z0-9]{32}。 取值范围: 不涉及 默认取值: 不涉及。 issue_id 是 Integer 参数解释: 工作项id,可通过[高级查询工作项]接口获取,响应消息体中的id字段的值就是工作项id。 约束限制: 正则表达式,[0-9]{1,10}。 取值范围: 最小长度:1,最大长度:10 默认取值: 不涉及 attachment_id 是 String 参数解释: 附件id。可以通过[查询工作项详情]接口获取,返回信息的accessories列表中的attachment_id即为附件id。 约束限制: 正则表达式:"[1-9][0-9]{0,10}"。 取值范围: 不涉及。 默认取值: 不涉及。
  • 请求示例 Post https://{endpoint}/v4/projects/0792b7d26cb74bd799cbae80063dc74a/attachments/upload ------WebKitFormBoundary1kuNerRnRVVybt65 Content-Disposition: form-data; name="attachment"; filename="demo.PNG" Content-Type: image/png
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 disk_filename String 参数解释: 云盘存储名。 取值范围: 不涉及。 file_name String 参数解释: 文件名。 取值范围: 不涉及。 id Integer 参数解释: 关联id。 取值范围: 不涉及。 issue_id Integer 参数解释: 工作项id。 取值范围: 不涉及。 project_id String 参数解释: 项目id。 取值范围: 不涉及。 size String 参数解释: 文件大小。 取值范围: 不涉及。 状态码:400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码:401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • URI POST /v4/projects/{project_id}/issues/{issue_id}/attachments/upload 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目的32位uuid,项目唯一标识,通过[查询项目列表]接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 正则表达式,[A-Za-z0-9]{32}。 取值范围: 不涉及 默认取值: 不涉及。 issue_id 是 Integer 参数解释: 工作项id,可通过[高级查询工作项]接口获取,响应消息体中的id字段的值就是工作项id。 约束限制: 正则表达式,[0-9]{1,10}。 取值范围: 最小长度:1,最大长度:10 默认取值: 不涉及
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释: 用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 最小长度:10,最大长度:32768。 默认取值: 不涉及。 表3 FormData参数 参数 是否必选 参数类型 描述 file 是 File 参数解释: 图片文件 约束限制: 图片大小上限 5M
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 img_id String 参数解释: 图片id 取值范围: 不涉及 img_url String 参数解释: 图片url 取值范围: 不涉及 状态码:400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码:401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 响应示例 状态码:200 OK { "options" : "select1,select2", "region" : "southchina", "id" : 1, "identifier" : "81abca040032407bb62d52536d69ce2d", "project_id" : 2282492, "tracker_id" : 3, "custom_field" : "custom_field34", "type" : "select", "name" : "test", "sort" : 1, "memo" : "description", "created" : "2020-06-02T10:45:09Z", "modified" : 1, "is_delete" : false }
  • 请求示例 Post https://{endpoint}/v3/0792b7d26cb74bd799cbae80063dc74a/custom-fields { "memo" : "描述", "name" : "test", "options" : "0792b7d26cb74bd799cbae80063dc74a", "scrum_type" : "Story", "type" : "text" }
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 created String 参数解释: 创建时间 取值范围: 不涉及 custom_field String 参数解释: 系统字段 取值范围: 不涉及 id Integer 参数解释: 字段ID 取值范围: 不涉及 identifier String 参数解释: 字段ID 取值范围: 不涉及 is_delete Boolean 参数解释: 是否被删除 取值范围: true,false memo String 参数解释: 字段描述 取值范围: 最小长度:0,最大长度:255 modified String 参数解释: 修改时间 取值范围: 不涉及 name String 字段名称参数解释: 字段名称 取值范围: 最小长度:1,最大长度:15 options String 参数解释: 字段选项 取值范围: 最小长度:1,最大长度:6000 project_id Integer 参数解释: 项目ID 取值范围: 不涉及 region String 参数解释: 区域 取值范围: 不涉及 sort Integer 参数解释: 显示排序 取值范围: 不涉及 tracker_id Integer 参数解释: 工作项类型id 取值范围: 2(任务/Task) 3(缺陷/Bug) 5(Epic) 6(Feature) 7(Story) type String 参数解释: 自定义字段类型 取值范围: textArea(多行文本) select(下拉框) radio(单选框,text 单行文本) checkbox(多选框) date(日期) time_date(日期:包含时分,包含时分的日期类型的字段显示格式为:2019/10/10 10:10) number(数字) 状态码:400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码:401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • URI POST /v3/{project_id}/custom-fields 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目的32位uuid,项目唯一标识,通过[查询项目列表]接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 正则表达式,[A-Za-z0-9]{32}。 取值范围: 不涉及 默认取值: 不涉及。
  • 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 memo 是 String 参数解释: 自定义字段描述 约束限制: 不涉及 取值范围: 最小长度:0,最大长度:255 默认取值: 不涉及 name 是 String 参数解释: 自定义字段名称 约束限制: 正则表达式:[a-zA-Z0-9\u4E00-\u9FA5-_]{1,15}。 取值范围: 最小长度:1,最大长度:15 默认取值: 不涉及 options 是 String 参数解释: 自定义字段类型 约束限制: 正则表达式,[\s\S]{1,6000}。 取值范围: 最小长度:1,最大长度:6000 默认取值: 不涉及 scrum_type 是 String 参数解释: 当前新建的自定义字段应用的工作项类型 约束限制: 正则表达式,(Epic|Feature|Story|Task|Bug)。 取值范围: 最小长度:0,最大长度:7 默认取值: 不涉及 type 是 String 参数解释: 自定义字段类型 约束限制: 正则表达式,(textArea|select|radio|text|checkbox|date|time_date|number)。 对应参数解释: textArea(多行文本) select(下拉框) radio(单选框,text 单行文本) checkbox(多选框) date(日期) time_date(日期:包含时分,包含时分的日期类型的字段显示格式为:2019/10/10 10:10) number(数字) 取值范围: 最小长度:0,最大长度:7 默认取值: 不涉及
  • 响应示例 状态码:200 OK { "description" : "this is demo", "project_id" : "2e76d6f0b2c5403796e36bf63c5d5561", "project_name" : "testdemo", "project_num_id" : 708168641, "project_type" : "scrum", "user_num_id" : 700145037 } 状态码:400 Bad Request { "error_code" : "PM.00000001", "error_msg" : "param error" }
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 description String 参数解释: 项目描述。 取值范围: 不涉及。 project_id String 参数解释: 项目id。 取值范围: 不涉及。 project_name String 参数解释: 项目名。 取值范围: 不涉及。 project_num_id Integer 参数解释: 项目数字id。 取值范围: 不涉及。 project_type String 参数解释: 项目类型。 取值范围: 不涉及。 user_num_id Integer 参数解释: 创建者的数字id。 取值范围: 不涉及。 状态码:400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码:401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 最小长度:10,最大长度:32768。 默认取值: 不涉及。 表2 请求Body参数 参数 是否必选 参数类型 描述 description 否 String 参数解释: 项目描述。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 enterprise_id 否 String 参数解释: 项目要绑定的企业项目ID,可以通过[获取项目详情]接口获取,响应消息体中的enterprise_id字段的值就是项目要绑定的企业项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 project_name 是 String 参数解释: 项目名称。 约束限制: 最小长度:1,最大长度:128。 取值范围: 不涉及。 默认取值: 不涉及。 project_type 是 String 参数解释: 项目类型。 约束限制: 正则表达式:"scrum|normal|xboard|basic|phoenix|ipd"。 取值范围: scrum(scrum项目) normal(normal项目) xboard(看板项目) basic(basic项目) phoenix(凤凰项目) ipd(IPD项目template_id必传) 默认取值: 不涉及。 source 否 String 参数解释: 项目来源。 约束限制: 包含0到64个字符,字符可以是字母、数字、中文字符、空白字符以及特定的特殊字符。 取值范围: 不涉及。 默认取值: 不涉及。 template_id 否 Integer 参数解释: 用户创建的项目模板id。 约束限制: 当project_type字段值为ipd时,template_id可选值为10001,10002,10003,分别对应IPD-系统设备类,IPD-独立软件类,IPD-自运营软件/云服务类 取值范围: 10001(IPD-系统设备类) 10002(IPD-独立软件类) 10003(IPD-自运营软件/云服务类) 默认取值: 不涉及。
  • 响应示例 状态码:200 OK { "members" : [ { "domain_id" : "4e919d73499648e3b0292cd3cbef806a", "domain_name" : "demo_user_name", "user_id" : "a360371833bf4c558f796fd707b44daf", "user_name" : "demo_user_name", "user_num_id" : 4097, "role_id" : 7, "nick_name" : "name", "role_name" : "项目创建者", "user_type" : "User", "forbidden" : 0 } ], "total" : 1 }
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 members Array of members objects 参数解释: 项目成员列表。 total Integer 参数解释: 总数。 取值范围: 不涉及。 表4 members 参数 参数类型 描述 domain_id String 参数解释: 租户id。 取值范围: 不涉及。 domain_name String 参数解释: 租户名。 取值范围: 不涉及。 user_id String 参数解释: 用户id。用户在系统中的唯一编号。 取值范围: 不涉及。 user_name String 参数解释: 用户名。 取值范围: 不涉及。 user_num_id Integer 参数解释: 创建人numId。用户int类型的编号,有部分删除接口需要。 取值范围: 不涉及。 role_id Integer 参数解释: 成员角色id,取值范围枚举值中的key。 取值范围: -1( 项目创建者); 3 (项目经理); 4( 开发人员); 5 (测试经理); 6( 测试人员); 7 (参与者); 8 (浏览者); 9 (运维经理)。 nick_name String 参数解释: 用户昵称。 取值范围: 不涉及。 role_name String 参数解释: 用户角色,取值范围枚举值中的value。 取值范围: 项目创建者、项目经理、 开发人员、测试经理、测试人员、参与者、浏览者、运维经理等。 user_type String 参数解释: 用户类型。 取值范围: User(iam用户); Federation(联邦账号); forbidden Integer 参数解释: 是否是禁用账号。 取值范围: 1 禁用账号, 0非禁用账号。 状态码:400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码:401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • URI GET /v4/projects/{project_id}/members 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目的32位uuid,项目唯一标识,通过[查询项目列表]接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 正则表达式,[A-Za-z0-9]{32}。 取值范围: 不涉及 默认取值: 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 limit 是 Integer 参数解释: 条数,每页显示查询的数量。 约束限制: 不涉及。 取值范围: 最小值:1,最大值:1000。 默认取值: 10 offset 是 Integer 参数解释: 分页索引,偏移量,offset是limit的整数倍数。 约束限制: 从0开始。 取值范围: 最小值:0,最大值:10000。 默认取值: 缺省值:0
  • 创建注册配置中心 进入购买注册配置中心页面。 参考下表设置参数,参数前面带*号的是必须设置的参数。 参数 说明 计费模式 选择计费方式,目前支持: 包年/包月 按需计费 *企业项目 选择Nacos所在的项目,可在下拉框中搜索和选择需要的企业项目。 企业项目是一种云资源管理方式,企业项目管理服务提供统一的云资源按项目管理,以及项目内的资源管理、成员管理。 参考开通企业项目,创建并启用新的企业项目后可以使用,默认选择default。 注册配置中心Nacos引擎创建完成后,可将Nacos引擎资源迁出当前企业项目,迁入到新的企业项目,具体操作请参考迁出企业项目资源和为企业项目迁入资源。 *引擎名称 输入Nacos引擎的名称,名称以字母开头,由字母、数字和-组成,且不能以-结尾,长度为3~24个字符。名称不允许命名为“default”。 *注册配置中心类型 选择注册配置中心类型“Nacos”。 *选择实例数 选择需要的容量规格。 说明: 当您需要Nacos引擎微服务实例数大于2,000时需要提交工单申请。 版本 只能创建最新版本。 *网络 为引擎选择虚拟私有云及子网,可以为您的引擎构建隔离的、自主配置和管理的虚拟网络环境。 使用已创建的VPC,可在下拉列表中搜索和选择当前账号已创建的虚拟私有云和子网。 使用新的VPC,可单击“控制台”进入“虚拟私有云”页面,创建新的VPC,具体操作请参考创建虚拟私有云和子网。 标签 用于标识云资源,当您拥有相同类型的许多云资源时,可以使用标签按各种维度(例如用途、所有者或环境)对云资源进行分类。 您可以单击“ 添加标签”,在“添加标签”弹框输入标签键和标签值,添加标签,标签的命名规则请参见管理标签。在“添加标签”弹框,可单击“ 新增标签”同时添加多个标签,也可单击标签后的,删除该标签。 *购买时长 计费模式选择“包年/包月”时需要设置。可设置是否开通自动续费。 单击“立即购买”,进入引擎信息确认界面。 单击“提交”,引擎开始创建,当“运行状态”为“可用”时,引擎创建完成。
  • 创建应用网关 进入购买应用网关页面。 参考下表设置参数,参数前面带*号的是必须设置的参数。 参数 说明 *企业项目 选择网关所在的项目,可在下拉框中搜索和选择需要的企业项目。 企业项目是一种云资源管理方式,企业项目管理服务提供统一的云资源按项目管理,以及项目内的资源管理、成员管理。 参考开通企业项目,创建并启用新的企业项目后可以使用,默认选择default。 应用网关创建完成后,可将应用网关资源迁出当前企业项目,迁入到新的企业项目,具体操作请参考迁出企业项目资源和为企业项目迁入资源。 *引擎名称 输入应用网关名称,名称以字母开头,由字母、数字和-组成,且不能以-结尾,长度为3~24个字符,且名称不能以default命名。 *产品版本 目前只支持专业版。 *规格 选择实例规格。当前支持规格有:小型、中型、大型和超大型。 可用区 您可根据实际情况选择可用区。 *版本 只能创建最新版本。 *节点数 选择网关的节点数量,节点数量不少于2个。 *入口网络 为应用网关选择虚拟私有云及子网,此子网作为入口网络,用于选择可用的弹性负载均衡,需与后端VPC子网网络互通,具体操作请参考对等连接。 使用已创建的VPC,可在下拉列表中搜索和选择当前账号已创建的虚拟私有云和子网。 使用新的VPC,可单击“控制台”进入“虚拟私有云”页面,创建新的VPC,具体操作请参考创建虚拟私有云和子网。 使用共享VPC,请在下拉列表选择其他账号共享给当前账号的VPC。 共享VPC基于 资源访问管理 (Resource Access Manager,简称 RAM )服务的机制,VPC的所有者可以将VPC内的子网共享给一个或者多个账号使用。通过共享VPC功能,可以简化网络配置,帮助您统一配置和运维多个账号下的资源,有助于提升资源的管控效率,降低运维成本。有关VPC子网共享的更多信息,请参见共享VPC。 *弹性负载均衡 选择已创建的弹性负载均衡。 若当前没有可用的弹性负载均衡,可单击“购买弹性负载均衡”进入弹性负载均衡页面进行购买。 *后端网络 为应用网关选择虚拟私有云及子网,此子网作为后端网络,默认同入口网络一致。若同入口网络不一致时,需要打通网络。 使用已创建的VPC,可在下拉列表中搜索和选择当前账号已创建的虚拟私有云和子网。 使用新的VPC,可单击“控制台”进入“虚拟私有云”页面,创建新的VPC,具体操作请参考创建虚拟私有云和子网 使用共享VPC,请在下拉列表选择其他账号共享给当前账号的VPC。 共享VPC基于资源访问管理(Resource Access Manager,简称RAM)服务的机制,VPC的所有者可以将VPC内的子网共享给一个或者多个账号使用。通过共享VPC功能,可以简化网络配置,帮助您统一配置和运维多个账号下的资源,有助于提升资源的管控效率,降低运维成本。有关VPC子网共享的更多信息,请参见共享VPC。 维护时间窗 运维操作时间。单击参数后的可以修改时间窗。具体操作请参考修改应用网关维护时间窗。 标签 用于标识云资源,当您拥有相同类型的许多云资源时,可以使用标签按各种维度(例如用途、所有者或环境)对云资源进行分类。 您可以单击“ 添加标签”,在“添加标签”弹框输入标签键和标签值,添加标签,标签的命名规则请参见管理标签。在“添加标签”弹框,可单击“ 新增标签”同时添加多个标签,也可单击标签后的,删除该标签。 单击“立即购买”,网关开始创建,当“运行状态”为“可用”时,应用网关创建完成。
  • 约束与限制 应用网关创建完成后,不支持变更虚拟私有云。 当前仅支持独享型网络型负载均衡器。默认会使用所选ELB的80、443端口,如果选择的负载均衡器已经占用了部分端口,会创建失败。 ELB被应用网关使用后,为其配置的用于应用网关使用的监听器(即监听器名称中包含应用网关名称)及其关联的后端服务器组和后端服务器均不允许被删除。 各VPC网段不冲突。 当前端ELB与后端网络不同VPC时,需开启ELB的跨VPC后端,具体操作请参考跨VPC后端。
  • 扩容应用网关 应用网关规格支持在线扩容,只有低规格的实例支持扩容到高规格。 登录微服务引擎控制台。 左侧导航栏选择“应用网关 ”。 单击待操作的实例“操作”栏的“规格变更”,也可在应用网关的“基础信息”页面,单击“基础信息”区域“容量规格”后的“规格变更”。 在“应用网关规格变更”页面,选择待变更的规格。 单击“立即变更”,确认无误后,单击“提交”。待实例运行状态由“变更中”变成“可用”时,扩容成功。 父主题: 管理应用网关
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全