华为云用户手册

  • 响应消息 正常响应要素说明 表2 要素说明 名称 是否必选 参数类型 说明 binlog_retention_hours 是 Integer 二进制日志保留时间。 binlog_clear_type 否 String 二进制日志保留策略,取值:time、fast time:表示按时长保留二进制文件。 fast:表示快速清理,不保留二进制文件。 正常响应样例 { "binlog_retention_hours": 3, "binlog_clear_type": "time" } 异常响应 请参见异常请求结果。
  • 响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 quotas Object 参数解释: 配额列表对象。 详情请参见表3。 表3 quotas字段数据结构说明 名称 参数类型 说明 resources Array of objects 参数解释: 资源列表对象。 详情请参见表4。 表4 resources字段数据结构说明 名称 参数类型 说明 quota Integer 参数解释: 项目资源配额。 取值范围: 不涉及。 used Integer 参数解释: 已使用的资源数量。 取值范围: 不涉及。 type String 参数解释: 项目资源类型。 取值范围: instance:实例类型资源。 正常响应样例 { "quotas" : { "resources" : [ { "quota" : 100, "used" : 1, "type" : "instance" } ] } } 异常响应 请参见异常请求结果。
  • URI URI格式 GET /v3/{project_id}/instances/{instance_id}/slowlog?start_date={start_date}&end_date={end_date} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id 是 要查询的实例ID。 start_date 是 开始日期,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 end_date 是 结束时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。只能查询当前时间前一个月内的慢日志。 offset 否 页偏移量,如1、2、3、4等,不填时默认为1,表示查询当前第一页的数据。 支持查询数据库最近的2000条慢日志信息,参数值须满足offset x limit取值小于等于2000。示例:offset取值为200,limit取值10。 limit 否 每页多少条记录,取值范围是1~100,不填时默认为10。 type 否 语句类型,取空值,表示查询所有语句类型,也可指定如下日志类型: INSERT UPDATE SELECT DELETE CREATE
  • 请求消息 请求参数 无。 URI样例 GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/slowlog?offset=1&limit=10&start_date=2018-08-06T10:41:14+0800&end_date=2018-08-07T10:41:14+0800&type=INSERT
  • 响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 slow_log_list Array of objects 具体信息。 详情请参见表3。 total_record Integer 总记录数。 表3 slow_log_list字段数据结构说明 名称 参数类型 说明 count String 执行次数。 time String 执行时间。 lock_time String 等待锁时间。 rows_sent String 结果行数量。 rows_examined String 扫描的行数量。 database String 所属数据库。 users String 账号。 query_sample String 执行语法。慢日志默认脱敏显示,如需明文显示,请联系客服人员添加白名单。 type String 语句类型。 start_time String 发生时间,UTC时间。 client_ip String IP地址。 正常响应样例 { "total_record": 1, "slow_log_list": [ { "count": "1", "time": "1.04899 s", "lock_time": "0.00003 s", "rows_sent": "0", "rows_examined": "0", "database": "mysql", "users": "root", "query_sample": "INSERT INTO time_zone_name (Name, Time_zone_id) VALUES (N, @time_zone_id);", "type": "INSERT", "start_time": "2018-08-06T10:41:14", "client_ip": "192.*.*.1" } ] } 异常响应 请参见异常请求结果。
  • 请求消息 表2 参数说明 名称 是否必选 参数类型 说明 name 是 String 实例名称。 用于表示实例的名称,同一租户下,同类型的实例名可重名。取值规则如下: RDS for MySQL支持的字符长度是4~64个字节,必须以字母或中文开头,区分大小写,可以包含字母、数字、中文字符(一个中文字符占用3个字节)、中划线、点或者下划线,不能包含其他的特殊字符。 RDS for PostgreSQL和RDS for SQL Server支持的字符长度是4~64个字节,必须以字母或中文开头,区分大小写,可以包含字母、数字、中文字符(一个中文字符占用3个字节)、中划线或者下划线,不能包含其他的特殊字符。
  • URI URI格式 GET /v3/{project_id}/instances/{instance_id}/major-version/upgrade-histories?offset={offset}&limit={limit}&order={order}&sort_field={sort_field} 参数说明 表1 参数说明 名称 参数类型 是否必选 说明 project_id String 是 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id String 是 实例ID。 offset Integer 否 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。 limit Integer 否 查询记录数。默认为10,不能为负数,最小值为1,最大值为100。 order String 否 排序方式。 DESC:降序。 ASC:升序。 默认为降序。 sort_field String 否 排序字段。 start_time:开始时间。 end_time:结束时间。 默认为开始时间。
  • 响应消息 正常响应要素说明 表2 参数说明 名称 参数类型 说明 total_count Integer 总记录数。 upgrade_reports Array of objects 升级报告信息。 详情请参见表3。 表3 upgrade_report字段数据结构说明 名称 参数类型 说明 id String 升级报告ID。 start_time String 升级开始时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 end_time String 升级结束时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 src_instance_id String 原实例ID。 src_database_version String 原数据库版本。 dst_instance_id String 目标实例ID。 dst_database_version String 目标数据库版本。 result String 升级结果。 success:表示成功。 failed:表示失败。 running:表示升级中。 is_private_ip_changed Boolean 是否将实例内网IP切换到目标大版本实例。 true:表示切换。 false:表示不切换。 private_ip_change_time String 实例内网IP修改时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 statistics_collection_mode String 统计信息收集模式。 before_change_private_ip:修改实例内网IP前收集。 after_change_private_ip:修改实例内网IP后收集。 detail String 升级报告详情。 正常响应样例 { "total_count": 1, "upgrade_reports": [ { "id": "1a8fda5a-17a6-ebc4-bf1f-97ae837f432b", "start_time": "2023-03-06T02:45:49+0800", "end_time": "2023-03-06T02:50:49+0800", "src_instance_id": "dccacebb7b884ee18bc5c02c918ef2b0in03", "src_database_version": "13.9", "dst_instance_id": "6b5750504be1403191c4f00e4ffaee5ein03", "dst_database_version": "14.6", "result": "success", "is_private_ip_changed": true, "private_ip_change_time": "2023-03-06T03:10:49+0800", "statistics_collection_mode": "before_change_private_ip", "detail": "2023-03-06 18:33:26 --- pg_upgrade upgrade task begin" } ] } 异常响应 请参见异常请求结果。
  • 请求样例 https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/configurations/463b4b58-d0e8-4e2b-9560-5dea4552fde9/apply { "instance_ids": ["73ea2bf70c73497f89ee0ad4ee008aa2in01", "fe5f5a07539c431181fc78220713aebein01"] }
  • 响应消息 正常响应要素说明 表3 要素说明 名称 参数类型 说明 configuration_id String 参数模板ID。 configuration_name String 参数模板名称。 apply_results Array of objects 参数模板应用具体结果。 详情请参见表4。 success Boolean 参数模板是否都应用成功。 “true”表示参数模板都应用成功。 “false”表示存在应用失败的参数模板。 job_id String 任务流ID。 表4 apply_results字段数据结构说明 名称 参数类型 说明 instance_id String 实例ID。 instance_name String 实例名称。 restart_required Boolean 实例是否需要重启。 “true”需要重启。 “false”不需要重启。 success Boolean 参数模板是否应用成功。 “true”表示应用成功。 “false”表示应用失败。 正常响应样例 { "configuration_id": "cf49bbd7d2384878bc3808733c9e9d8bpr01", "configuration_name": "paramsGroup-bcf9", "job_id":"e4942c94-9d66-458e-beb7-90601664641e", "apply_results": [{ "instance_id": "fe5f5a07539c431181fc78220713aebein01", "instance_name": "zyy1", "restart_required": false, "success": false }, { "instance_id": "73ea2bf70c73497f89ee0ad4ee008aa2in01", "instance_name": "zyy2", "restart_required": false, "success": false }], "success": false } 异常响应 请参见异常请求结果。
  • 响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 total_count Integer 参数解释: 回收站数据条数。 取值范围: 不涉及。 instances Array of objects 参数解释: 回收站信息,详细说明请参见表3。 表3 instances字段数据结构说明 参数 参数类型 描述 id String 参数解释: 实例ID。 取值范围: 不涉及。 name String 参数解释: 实例名称。 取值范围: 不涉及。 ha_mode String 参数解释: 实例主备模式。 取值范围: 不区分大小写。 Single:单机实例。 Ha:主备实例。 engine_name String 参数解释: 引擎名称。 取值范围: 不涉及。 engine_version String 参数解释: 数据库引擎版本。 取值范围: 不涉及。 pay_model String 参数解释: 计费方式。 取值范围: 0:按需计费。 1:包周期计费。 created_at String 参数解释: 创建时间。 取值范围: 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 deleted_at String 参数解释: 删除时间。 取值范围: 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 volume_type String 参数解释: 磁盘类型。 取值范围: ULTRAHIGH,表示超高IO型磁盘。 ULTRAHIGHPRO,表示SSD尊享版,仅支持超高性能型尊享版(需申请权限)。 CLOUDSSD,表示SSD云盘,仅支持通用型和独享型规格实例。 LOCALSSD,表示本地SSD盘。 volume_size Integer 参数解释: 磁盘大小。 取值范围: 40 GB~4000 GB,必须为10的整数倍。 部分用户支持40 GB~6000 GB,如果您想创建存储空间最大为6000 GB的数据库实例,或提高扩容上限到10000 GB,请联系客服开通。 对于只读实例,该参数无效,只读实例磁盘大小默认和主实例相同。 data_vip String 参数解释: 内网地址。 取值范围: 不涉及。 data_vip_v6 String 参数解释: IPv6内网地址。 取值范围: 不涉及。 enterprise_project_id String 参数解释: 企业项目ID。 取值范围: 不涉及。 retained_until String 参数解释: 保留时间。 取值范围: 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 recycle_backup_id String 参数解释: 备份ID。 取值范围: 不涉及。 recycle_status String 参数解释: 备份状态。 取值范围: BUILDING:备份中,不能进行重建。 COMPLETED:备份完成,可以重建实例。 is_serverless Boolean 参数解释: 实例类型。 取值范围: true:表示Serverless实例。 false:表示非Serverless实例。 正常响应样例 { "total_count" : 2, "instances" : [ { "id" : "b7dea08c0f0e4fed9f1951fff9013639in01", "name" : "rds-8b86", "ha_mode" : "Ha", "engine_name" : "mysql", "engine_version" : "5.7.38", "pay_model" : "0", "created_at" : "2022-12-26T03:38:10+0000", "deleted_at" : "2023-01-09T08:57:10+0000", "volume_type" : "SSD", "volume_size" : 80, "data_vip" : "192.168.226.188", "enterprise_project_id" : "0", "retained_until" : "2023-01-16T09:20:48+0000", "recycle_backup_id" : "e8e3c329c20442f5aec21b95a8cdaa52br01", "recycle_status" : "COMPLETED", "is_serverless" : false }, { "id" : "cc6d0dff4a9145d0a1335c35a866de23in01", "name" : "rds-82b2", "ha_mode" : "Ha", "engine_name" : "mysql", "engine_version" : "5.7.38", "pay_model" : "0", "created_at" : "2022-12-26T06:17:58+0000", "deleted_at" : "2023-01-09T08:56:49+0000", "volume_type" : "SSD", "volume_size" : 200, "data_vip" : "192.168.2.24", "enterprise_project_id" : "0", "retained_until" : "2023-01-16T09:20:45+0000", "recycle_backup_id" : "3f35a348ae0943979bd302a9788f49e7br01", "recycle_status" : "COMPLETED", "is_serverless" : false } ] } 异常响应 请参见异常请求结果。
  • URI URI格式 GET /v3/{project_id}/recycle-instances?offset={offset}&limit={limit} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 offset 是 参数解释: 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询。 约束限制: 不涉及。 取值范围: 必须为数字,不能为负数。 默认取值: 不涉及。 limit 是 参数解释: 每页数据条数。 约束限制: 不涉及。 取值范围: [1, 50] 默认取值: 不涉及。
  • 响应示例 { "resCode": "0", "resMsg": "成功", "result": { "methodName": "run", "methodObject": "Calculator", "label": "", "description": "do a operation", "script": "命名空间__editEquipment", "types": { "Input": [ { "name": "op", "label": "", "description": "the operation type", "isCollection": false, "required": true, "pattern": "", "message": "", "valueType": "String", "structType": "", "lengthInCharacter": false, "min": null, "max": null }, { "name": "value1", "label": "", "description": "the operation value 1", "isCollection": false, "required": true, "pattern": "", "message": "", "valueType": "Number", "structType": "", "lengthInCharacter": false, "min": null, "max": null }, { "name": "value2", "label": "", "description": "the operation value 2", "isCollection": false, "required": true, "pattern": "", "message": "", "valueType": "Number", "structType": "", "lengthInCharacter": false, "min": null, "max": null } ], "Output": [ { "name": "result", "label": "", "description": "", "isCollection": false, "required": true, "pattern": "", "message": "", "valueType": "Number", "structType": "", "lengthInCharacter": false, "min": null, "max": null } ] }, "inputs": [ { "name": "op", "label": "", "description": "the operation type", "isCollection": false, "required": true, "pattern": "", "message": "", "valueType": "String" }, { "name": "value1", "label": "", "description": "the operation value 1", "isCollection": false, "required": true, "pattern": "", "message": "", "valueType": "Number" }, { "name": "value2", "label": "", "description": "the operation value 2", "isCollection": false, "required": true, "pattern": "", "message": "", "valueType": "Number" } ], "input": "Input", "outputs": [ { "name": "result", "label": "", "description": "", "isCollection": false, "required": true, "pattern": "", "message": "", "valueType": "Number" } ], "output": "Output" } }
  • 响应参数 表2 响应参数 参数 参数类型 描述 resCode String 参数解释: 返回码。 取值范围: 如果返回“0”代表请求成功,其他错误码说明请参考错误码。 resMsg String 参数解释: 返回消息。 取值范围: 成功返回“成功”,其他情况会返回具体的错误信息。 result result object 参数解释: 在成功请求时,会有内容返回。 表3 result参数说明 参数 参数类型 描述 description String 参数解释: 脚本的描述信息。 取值范围: 不涉及。 script String 参数解释: 脚本的名称。 取值范围: 不涉及。 methodName String 参数解释: 方法名称,在脚本使用@action.method注解后才会有方法名。 取值范围: 不涉及。 methodObject String 参数解释: 方法所属的类。 取值范围: 不涉及。 input String 参数解释: 输入类型,一般为Input。在定义脚本出入参时,会定义一个入参类和出参类,这里input即为入参类名。 取值范围: 不涉及。 output String 参数解释: 输出类型,一般为Output。在定义脚本出入参时,会定义一个入参类和出参类,这里output即为出参类名。 取值范围: 不涉及。 label String 参数解释: 脚本的标签。 取值范围: 不涉及。 inputs Array of inputs objects 参数解释: 输入类型中的变量信息描述。 outputs Array of inputs objects 参数解释: 输出类型中的变量信息描述。 types Object 参数解释: 脚本中使用@action.param注解的类名。
  • 请求示例 示例1 如下请求创建了一个仅执行一次的数据导出任务,执行时间为2020-05-31 00:00:00,导出的文件格式为csv,编码格式为utf-8,需要导出的对象通过名为“myTemplate”的模板指定,未指定任何导出筛选条件。 POST https://华为云Astro轻应用 域名 /u-route/baas/bulk/v1.0/export/data?flag=template&file_type=csv { "scheduleMode": 1, "firstScheduleDate": "2020-05-31 00:00:00", "encodeType": "utf-8", "templateName": "myTemplate" } 示例2 如下请求创建了周期性执行的数据导出任务,首次执行时间为2020-06-01 00:00:00,往后每隔一个月执行一次,导出的文件格式为txt,编码格式为GBK,需要导出的对象以数组的形式列在objects中,同时设定筛选条件,仅导出创建者id(createBy)为“1234567890xyz”的数据。 POST https://华为云Astro轻应用域名/u-route/baas/bulk/v1.0/export/data?flag=template&file_type=txt { "scheduleMode": 2, "firstScheduleDate": "2020-06-01 00:00:00", "scheduleInterval": 1, "intervalUnit": "Month", "templateName": "template01", "encodeType": "gbk", "objects": [ "Flow", "Page" ], "cond": { "conjunction": "AND", "conditions": [ { "field": "createdBy", "operator": "eq", "value": "1234567890xyz" } ] } }
  • URI POST 华为云Astro轻应用域名/u-route/baas/bulk/v1.0/export/data?flag=template&file_type=csv 表1 路径参数 参数 是否必选 参数类型 描述 file_type 是 String 参数解释: 导出文件的格式,支持csv格式和txt格式。 约束限制: 不涉及。 取值范围: csv:数据以csv格式导出。 txt:数据以txt格式导出。 默认取值: 不涉及。
  • 请求参数 表2 请求参数 参数 是否必选 参数类型 描述 cond 否 cond object 参数解释: 导出筛选条件,为一个结构体,包含conditions和conjunction两个字段。 约束限制: 不涉及。 encodeType 是 String 参数解释: 导出文件的编码格式。 约束限制: 不涉及。 取值范围: 支持“UTF-8”和“GBK”两种类型。 默认取值: 不涉及。 firstScheduleDate 否 String 参数解释: 首次导出时间,格式为“yyyy-MM-dd HH:mm:ss” 约束限制: scheduleMode=2时,必选。 scheduleMode=1时,与isImmediate互斥。 取值范围: 不涉及。 默认取值: 不涉及。 objects 否 Array of Strings 参数解释: 需要导出的对象,为一字符串数组,数组中每个字符串为一个对象名,可同时导出多个对象数据,也可通过templateName参数指定模板选择导出的数据。 约束限制: 不涉及。 scheduleMode 是 Number 参数解释: 导出任务的执行次数。 约束限制: 不涉及。 取值范围: 1:仅执行一次。 2:按设定的频率执行多次。 默认取值: 不涉及。 scheduleInterval 否 Number 参数解释: 导出任务的执行间隔。 约束限制: “scheduleMode=2”时必选。 取值范围: 不涉及。 默认取值: 不涉及。 intervalUnit 否 Number 参数解释: 导出任务执行间隔对应的单位。 约束限制: “scheduleMode=2”时必选。 取值范围: Hour:小时。 Day:天。 Month:月。 默认取值: 不涉及。 isImmediate 否 Boolean 参数解释: 是否立即导出。 约束限制: “scheduleMode=1”时可选,“scheduleMode=1”时与firstScheduleDate互斥。 取值范围: 不涉及。 默认取值: 不涉及。 templateName 否 String 参数解释: 数据导出使用的模板名称,也可通过objects参数直接指定希望导出的对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表3 cond参数说明 参数 参数类型 描述 conditions Array of condition objects 参数解释: 条件数组,数组中每项作为一个条件。 约束限制: 不涉及。 conjunction String 参数解释: conditions数组中各个条件的组合方式。 约束限制: 不涉及。 取值范围: AND:与。 OR:或。 默认取值: 不涉及。 表4 条件参数condition说明 参数 是否必选 描述 field 是 参数解释: 筛选条件字段。 约束限制: 不涉及。 取值范围: createDate:创建时间。 createBy:创建者ID。 lastModifiedDate:最后编辑时间。 lastModifiedBy:最后编辑者ID。 默认取值: 不涉及。 operator 是 参数解释: 筛选运算操作。 约束限制: 只有时间类型的筛选字段支持所有操作,其他类型的字段仅支持eq/ne(等于或不等于)。 取值范围: gt:大于。 ge:大于等于。 eq:等于。 ne:不等于。 lt:小于。 le:小于等于。 timeFunc:时间函数。 默认取值: 不涉及。 value 是 参数解释: 进行比较的具体值。 约束限制: 不涉及。 取值范围: 当“operator”为“timeFunc”时,支持使用以下函数: today:今天。 yesterday:昨天。 last week:上周。 last month:上月。 last year:去年。 this week:本周。 this month:本月。 this year:今年。 若比较的字段为时间类型,则此处使用的时间字符串应为“yyyy-MM-dd HH:mm:ss”格式。 默认取值: 不涉及。
  • 使用流程 图1 轮转密码流程 流程说明如下: 定时触发器到期后,会发布定时触发事件。 函数工作流 接收到事件后,会生成新的随机密码,替换凭据模板内容中的占位符,随后将替换后的内容作为新版本存入凭据中。 应用程序定期通过调用API/SDK获取最新凭据版本。 凭据管理服务检索并解密凭据密文,将凭据中保存的信息通过凭据管理API安全地返回到应用程序中。 应用程序获取到解密后的凭据明文信息,使用新密码更新目标对象(数据库、服务器等),使新密码生效,后续使用新密码对目标对象进行访问。
  • 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}"。 取值范围: 不涉及。 默认取值: 不涉及。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 x-auth-token 是 String 参数解释:用户token。通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制:不涉及 取值范围:最小长度10,最大长度:32768 默认取值:不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 id 否 String 参数解释: id(发布、迭代、里程碑的id) 取值范围: 不涉及 title 否 String 参数解释: 标题 取值范围: 不涉及 category 否 String 参数解释: 分类,枚举 PI(发布) Iteration(迭代) PlanMilestone(里程碑) 取值范围: PI,Iteration,PlanMilestone description 否 String 参数解释: 描述 取值范围: 不涉及 status 否 String 参数解释: 状态,枚举 planned(未开始) going(进行中) ended(已完成) 取值范围: planned,going,ended children 否 Array of PlanVO objects 参数解释: 子项目迭代信息 modified_by 否 String 参数解释: 更新人 取值范围: 不涉及 plan_start_date 否 Long 参数解释: 计划开始时间,unix时间戳,单位:毫秒 取值范围: 不涉及 plan_end_date 否 Long 参数解释: 计划完成时间,unix时间戳,单位:毫秒 取值范围: 不涉及 created_date 否 Long 参数解释: 创建时间,unix时间戳,单位:毫秒 取值范围: 不涉及 parent_id 否 String 参数解释: 父工作项id 取值范围: 不涉及 baseline 否 String 参数解释: 基线状态,枚举 baselined(已基线) unbaseline(未基线) baseline-reviewing(基线评审中) 取值范围: baselined,unbaseline,baseline-reviewing workload 否 String 参数解释: 预估工作量 取值范围: 不涉及 owner 否 String 参数解释: 责任人ID 取值范围: 不涉及
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 status String 状态信息 message String 提示信息 result PlanVO object 创建的计划返回值 表5 PlanVO 参数 参数类型 描述 id String 参数解释: id(发布、迭代、里程碑的id) 取值范围: 不涉及 title String 参数解释: 标题 取值范围: 不涉及 category String 参数解释: 分类,枚举 PI(发布) Iteration(迭代) PlanMilestone(里程碑) 取值范围: PI,Iteration,PlanMilestone description String 参数解释: 描述 取值范围: 不涉及 state String 参数解释: 作废标识(可选值有:正在工作、作废、删除) 取值范围: 正在工作、作废、删除 status String 参数解释: 状态,枚举 planned(未开始) going(进行中) ended(已完成) 取值范围: planned,going,ended children Array of PlanVO objects 参数解释: 子项目迭代信息 created_by String 参数解释: 创建人 取值范围: 不涉及 modified_by String 参数解释: 更新人 取值范围: 不涉及 plan_start_date Long 参数解释: 计划开始时间,unix时间戳,单位:毫秒 取值范围: 不涉及 plan_end_date Long 参数解释: 计划完成时间,unix时间戳,单位:毫秒 取值范围: 不涉及 created_date Long 参数解释: 创建时间,unix时间戳,单位:毫秒 取值范围: 不涉及 parent_id String 参数解释: 父工作项id 取值范围: 不涉及 baseline String 参数解释: 基线状态,枚举 baselined(已基线) unbaseline(未基线) baseline-reviewing(基线评审中) 取值范围: baselined,unbaseline,baseline-reviewing workload String 参数解释: 预估工作量 取值范围: 不涉及 owner String 参数解释: 责任人ID 取值范围: 不涉及 状态码:400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 响应示例 状态码:200 OK { "status" : "success", "message" : "计划更新成功", "result" : { "id" : "123456789012345678", "title" : "更新后的计划标题", "category" : "PI", "description" : "这是更新后的计划描述", "state" : "正在工作", "status" : "going", "children" : [ ], "created_by" : "11111111111111111111111111111111", "modified_by" : "22222222222222222222222222222222", "plan_start_date" : 1701456000000, "plan_end_date" : 1702060800000, "created_date" : 1701456000000, "parent_id" : "0987654321fedcba0987654321fedcba", "baseline" : "unbaseline", "workload" : "20h", "owner" : "33333333333333333333333333333333" } } 状态码:400 错误信息 { "error_code" : "PM.02175011", "error_msg" : "parent_id参数非法" }
  • URI PUT /v1/planservice/projects/{project_id}/plans/{plan_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释:项目的32位uuid,项目唯一标识,可以通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID 约束限制:正则表达式,^[A-Za-z0-9]{32}$ 默认取值:不涉及 plan_id 是 String 参数解释:发布/迭代唯一Id。可以通过IPD项目计划管理章节中的发布/迭代计划列表查询接口获取,响应消息体中的id字段的值就是发布/迭代Id 约束限制:正则表达式,^([0-9]{18,19})$ 默认取值:不涉及
  • 请求示例 更新计划请求参数 https://{endpoint}/v1/planservice/projects/1234567890abcdef1234567890abcdef/plans/abcdef1234567890abcdef1234567890 { "title" : "更新后的计划标题", "category" : "PI", "description" : "这是更新后的计划描述", "status" : "going", "plan_start_date" : 1701456000000, "plan_end_date" : 1702060800000, "created_date" : 1701456000000, "parent_id" : "0987654321fedcba0987654321fedcba", "baseline" : "unbaseline", "workload" : "20h", "owner" : "33333333333333333333333333333333" }
  • 响应示例 状态码:200 OK { "status" : "初始", "id" : "1121459690961543169", "domain_id" : "1120389044916760576", "belonging" : "YCQ_IPD_M1_0419", "project_id" : "58b214adfc834e0bb71c09e212759423", "category" : "SF", "number" : "SF20250422376840", "title" : "SF迁移测试", "trace_list" : [ { "associate_type" : "associate_documents", "direction" : "right", "sequence" : 7, "entities" : [ ], "children" : [ ], "count" : 0 }, { "associate_type" : "child_issues", "direction" : "right", "sequence" : 4, "entities" : [ ], "children" : [ ], "count" : 0 }, { "associate_type" : "wikis", "direction" : "right", "sequence" : 8, "entities" : [ ], "children" : [ ], "count" : 0 }, { "associate_type" : "associate_workitems", "direction" : "right", "sequence" : 6, "entities" : [ ], "children" : [ { "associate_type" : "Task", "direction" : "right", "sequence" : 8, "entities" : [ ], "children" : [ ], "count" : 0 }, { "associate_type" : "RR", "direction" : "right", "sequence" : 1, "entities" : [ ], "children" : [ ], "count" : 0 } ], "count" : 0 }, { "associate_type" : "associate_testcases", "direction" : "right", "sequence" : 9, "entities" : [ ], "children" : [ ], "count" : 0 } ] }
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 id String 工作项id project_id String 项目id domain_id String 需求空间id belonging String 所属需求空间 category String 工作项类型 number String 工作项编号 status String 编号 title String 标题 trace_list Array of OpenAPIE2ETraceEntityMap objects 追溯项列表 message String 消息 表4 OpenAPIE2ETraceEntityMap 参数 参数类型 描述 associate_type String 关联类型 direction String 方向 sequence String 序号 entities Array of OpenAPIE2ETraceBaseEntity objects 追溯项列表 children Array of OpenAPIE2ETraceEntityMap objects 追溯项列表 count Integer 数量 表5 OpenAPIE2ETraceBaseEntity 参数 参数类型 描述 id String 树结构ID title String 标题 belonging String 归属项目 project_id String 归属项目 type String 类型 storage_type String 存储类型 category String 工作项类型 number String 编号 status String 状态 commit_id String commit id commit_short_id String commit short id commit_msg String 提交消息 commit_url String 提交url uri String uri
  • URI GET /v1/ipdprojectservice/projects/{project_id}/e2e/graphs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID 约束限制: 正则表达式,[A-Za-z0-9]{32} 取值范围: 不涉及 默认取值: 不涉及 表2 Query参数 参数 是否必选 参数类型 描述 issue_id 是 String 参数解释:工作项唯一Id。可以通过[查询工作项列表]或者[查询树状工作]接口获取,响应消息体中的id字段的值就是工作项ID 约束限制:正则表达式,^([0-9]{18,19})$ 默认取值:不涉及 category 是 String 工作项类型 is_src 否 Boolean 是否跨项目查询工作项
  • [Version Changes] Please carefully read the changes made to the Privacy Statement due to service development and optimization: Added the Shimo Docs function. Added the description of third-party services (mainly Shimo Docs) and added the personal information obtained from Shimo Docs to the personal information obtained from third parties in the section "How We Collect Your Personal Data." Added the third-party service provider Shimo Docs to the section "Third-Party Service Providers and Their Services." Added the transfer and virtual background functions of HarmonyOS. Added the description of personal information involved in HarmonyOS transfer and virtual background functions to the section "How We Collect Your Personal Data." Added the permission description for the HarmonyOS transfer function to section "Required Permissions." Added the 360 virtual background SDK of Qiku Software (Shenzhen) Co., Ltd. to the section "Third-Party Service Providers and Their Services." Removed the HiCar function. Added the description of bringing the HiCar function offline to sections "Required Permissions" and "Third-Party Service Providers and Their Services." Updated: July 27, 2022 View Huawei Cloud Meeting Privacy Statement
  • 以下为历史版本变更说明 版本变更说明 Meeting新增支持OPPO/VIVO手机推送会议通知功能,为此更新隐私声明。 “第三方SDK”章节中,新增OPUSH SDK、VIVO推送SDK。 “个人信息存储期限”章节中,增加推送功能个人数据留存期描述。 更新时间:2024年1月12日 点击查看华为云会议隐私声明全文 版本变更说明 因业务发展优化导致隐私声明更新,请您仔细阅读此次隐私声明的变更内容: Meeting新增支持企业微信用户快速登录华为云会议,新增电话权限适配Android 12系统,为此更新隐私声明。 “您提供的个人信息”章节中,新增1.2.2 企业微信登录功能相关描述及涉及的个人数据说明、新增1.2.5 音视频会议服务,含网络研讨会中电话权限、自启动相关描述。 “设备权限调用”章节中,新增Android系统电话权限描述、iOS系统本地网络权限描述。 “第三方SDK”章节中,新增企业微信登录分享SDK、统一扫描服务SDK。 更新时间:2024年1月5日 点击查看华为云会议隐私声明全文 版本变更说明 因业务发展优化导致隐私声明更新,请您仔细阅读此次隐私声明的变更内容: Meeting新增屏蔽周围人声功能,为此更新隐私声明。 “您提供的个人信息”章节中,新增1.2.13 屏蔽周围人声功能相关描述及涉及的个人数据说明。 “我们如何对个人信息进行存储”章节中,新增屏蔽周围人声涉及的个人数据留存期说明。 增加距离传感器、方向传感器、系统信息、运营商信息、Wi-Fi信息收集场景和使用说明。 优化隐私声明部分段落语言描述方式,以更为清晰和便于您理解的方式,向您展示我们如何收集和使用您的个人数据。 更新时间:2023年7月11日 点击查看华为云会议隐私声明全文 版本变更说明 因业务发展优化导致隐私声明更新,请您仔细阅读此次隐私声明的变更内容: Meeting服务新增支持石墨文档的功能,为此隐私更新 “我们收集和使用哪些信息”章节中,新增以石墨为代表的第三方服务相关描述,从第三方获取的个人信息中增加从石墨获取的个人数据 “第三方服务提供商及其服务”章节中,新增第三方供应商石墨 Meeting服务新增鸿蒙流转、虚拟背景功能,为此隐私更新 “我们收集和使用哪些信息”章节中,新增鸿蒙流转、虚拟背景中涉及的个人数据说明 “设备权限调用”章节中,新增鸿蒙流转使用的权限说明 “第三方服务提供商及其服务”章节中,新增360虚拟背景SDK(奇酷软件(深圳)有限公司) Meeting服务HiCar场景功能下线,为此隐私更新 “设备权限调用”章节、“第三方服务提供商及其服务”章节中,增加hicar场景功能下线说明 更新时间:2022年7月27日 点击查看华为云会议隐私声明全文 版本变更说明 因业务发展优化导致隐私声明更新,请您仔细阅读此次隐私声明的变更内容: 华为云会议服务新增SmartRooms、IdeaHub系列接入场景,为此更新隐私声明 “我们收集和使用哪些信息”章节中,新增SmartRooms、IdeaHub系列接入场景个人数据收集说明、权限使用场景说明、关闭自动收集路径的描述 “第三方服务提供商及其服务”章节中,新增第三方SDK说明 华为云会议服务新增用户体验改进计划,为此更新隐私声明 “我们如何使用您的个人信息”章节中,新增用户体验改进计划加入和退出的描述 华为云会议服务加强公共环境管理,调整了举报的留存期,为此更新隐私声明 “数据存储与保留”章节,举报留存期从30天调整到6个月 更新时间:2022年6月1日 点击查看华为云会议隐私声明全文
  • The following describes changes of earlier versions. [Version Changes] We have updated the Privacy Statement to improve your experience with this service. Please read the following to learn more about the relevant changes. Added the SmartRooms and IdeaHub access scenarios. Added the description of Personal Data collection, permissions, and path of disabling automatic collection in SmartRooms and IdeaHub access scenarios in Article "How We Collect Your Personal Data." Added the description of third-party SDKs in Article "Third-Party Service Providers and Their Services." Added the user experience improvement program. Added the description of joining and exiting the user experience improvement program in Article "How We Use Your Personal Data." Adjusted the report retention period for better public environment. Changed the report retention period from 30 days to 6 months in Section "Data Storage and Retention." Updated: June 1, 2022 View Huawei Cloud Meeting Privacy Statement
共100000条
提示

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