华为云用户手册

  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 id String 规则ID type String 规则类型 name String 规则名称 version String 规则版本 layout_content String 布局内容 plugin_id String 插件ID plugin_name String 插件名称 plugin_version String 插件版本号 creator String 创建人 create_time String 创建时间 updater String 更新人 update_time String 更新时间 content Array of RuleContent objects 规则属性列表 表4 RuleContent 参数 参数类型 描述 group_name String 分组名称 can_modify_when_inherit Boolean 继承后的子策略是否可以修改阈值 properties Array of RuleProperty objects 规则属性列表 表5 RuleProperty 参数 参数类型 描述 key String 属性键 type String 类型 name String 展示名称 operator String 比较运算符 value String 属性值 value_type String 数据类型 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 响应示例 状态码: 200 OK { "full_stage_plugins_item_list" : [ { "plugins_list" : [ { "unique_id" : "47d48e84-8a98-4ad1-8bc0-59c112a05c5b", "display_name" : "CloudBuild", "plugin_name" : "official_devcloud_cloudBuild", "disabled" : false, "group_name" : null, "group_type" : null, "plugin_attribution" : "official", "plugin_composition_type" : "single", "runtime_attribution" : "agent", "all_steps" : null, "description" : "CloudBuild capabilities can be called on the pipeline for building.CloudBuild provides an easy-to-use, cloud-based build platform that supports multiple programming languages, helping you achieve continuous delivery, with shorter delivery period and higher delivery efficiency. With CloudBuild, you can create, configure, and run build tasks with a few clicks. CloudBuild also supports automation of code retrieval, building, and packaging, as well as real-time status monitoring.", "version_attribution" : "formal", "icon_url" : "/api/v1/*/common/get-plugin-icon?object_key=official_devcloud_cloudBuild-d81c87f9977d4923a546d067a0001914-构建.png-ce8df55870164338a72d7e828a966a2a", "multi_step_editable" : 0, "standard" : true } ], "display_name" : "构建", "business_type" : "Build", "unique_id" : "f44ca008-ae9b-45ee-905d-711429382c71", "conditions" : null, "addables" : null, "editable" : false, "removable" : false, "cloneable" : false, "disabled" : false } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 full_stage_plugins_item_list Array of full_stage_plugins_item_list objects 结果集 表5 full_stage_plugins_item_list 参数 参数类型 描述 plugins_list Array of plugins_list objects 插件列表 display_name String 展示名 business_type String 业务类型 unique_id String 唯一ID conditions Array of strings 条件 addables Array of addables objects 额外属性 editable Boolean 是否可编辑 removable Boolean 是否可移除 cloneable Boolean 是否可复制 disabled Boolean 禁用 表6 plugins_list 参数 参数类型 描述 unique_id String 唯一ID display_name String 展示名 plugin_name String 插件名 disabled Boolean 禁用 group_name String 组名 group_type String 组类型 plugin_attribution String 插件属性 plugin_composition_type String 组合插件 runtime_attribution String 运行属性 all_steps Array of all_steps objects 基础插件列表 description String 描述 version_attribution String 版本属性 icon_url String 图标URL multi_step_editable Integer 是否可编辑 standard Boolean 标准 表7 all_steps 参数 参数类型 描述 plugin_name String 插件名 display_name String 展示名 version String 版本 表8 addables 参数 参数类型 描述 additionalProp1 Boolean 额外属性1 additionalProp2 Boolean 额外属性2 additionalProp3 Boolean 额外属性3 状态码: 400 表9 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 error_code String 错误码
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 use_condition 否 String 用于区分插件为流水线可使用/模板可使用 comp_id 否 String 微服务ID comp_name 否 String 微服务名 cloud_id 否 String 局点ID strategy_id 否 String 策略ID category 否 String 流水线类型 publish_tab 否 String 是否发布流水线 platform 否 String 部署平台 comp_extend_type 否 String 组件类型 deploy_type 否 String 部署类型
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 unique_id 否 String 唯一ID icon_url 否 String 图标URL runtime_attribution 否 String 运行属性 plugin_name 否 String 插件名 display_name 否 String 展示名 business_type 否 String 业务类型 business_type_display_name 否 String 业务类型展示名 description 否 String 描述 is_private 否 Integer 是否私有 region 否 String 局点 maintainers 否 String 维护者 plugin_composition_type 否 String 组合插件类型
  • 请求示例 POST https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/agent-plugin/update-info { "plugin_name" : "apie_test", "display_name" : "apie_test", "business_type" : "Normal", "description" : "1111", "maintainers" : "", "business_type_display_name" : "通用", "icon_url" : "" }
  • 请求示例 POST https://{endpoint}/v3/ce8df55870164338a72d7e828a966a2a/extension/info/update { "plugin_name" : "basic_plugin", "display_name" : "basic_plugin", "business_type" : "Normal", "description" : "", "maintainers" : "", "business_type_display_name" : "通用", "icon_url" : "" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 unique_id 否 String 唯一ID icon_url 否 String 图标URL runtime_attribution 否 String 运行属性 plugin_name 否 String 插件名 display_name 否 String 展示名 business_type 否 String 业务类型 business_type_display_name 否 String 业务类型展示名 description 否 String 描述 is_private 否 Integer 是否私有 region 否 String 局点 maintainers 否 String 维护者 plugin_composition_type 否 String 组合插件类型
  • 响应示例 状态码: 200 OK { "offset" : 0, "limit" : 3, "total" : 32, "data" : [ { "plugin_name" : "basic_plugin", "display_name" : "basic_plugin", "version" : "", "version_description" : null, "description" : "", "version_attribution" : "init", "unique_id" : "83edd75a8be5406496d9fc63ce6c984e", "op_user" : "devcloud_devcloud_h00485561_01", "op_time" : "1699355741000", "plugin_composition_type" : "single", "plugin_attribution" : "custom", "workspace_id" : "ce8df55870164338a72d7e828a966a2a", "business_type" : "Normal", "business_type_display_name" : "通用", "maintainers" : "", "icon_url" : "", "refer_count" : null, "usage_count" : null, "runtime_attribution" : "agent", "active" : 1 }, { "plugin_name" : "apie_test", "display_name" : "apie_test", "version" : "0.0.2", "version_description" : "", "description" : "", "version_attribution" : "formal", "unique_id" : "8287cdb4908741f889ed307d265677d1", "op_user" : "devcloud_devcloud_h00485561_01", "op_time" : "1699354371000", "plugin_composition_type" : "multi", "plugin_attribution" : "custom", "workspace_id" : "ce8df55870164338a72d7e828a966a2a", "business_type" : "Normal", "business_type_display_name" : "通用", "maintainers" : "", "icon_url" : "", "refer_count" : 0, "usage_count" : null, "runtime_attribution" : "agent", "active" : 0 }, { "plugin_name" : "asdasadsas", "display_name" : "dasddasas", "version" : "", "version_description" : null, "description" : "", "version_attribution" : "init", "unique_id" : "4fccd9e61c424d1298cc9e5f71e7c9e7", "op_user" : "devcloud_devcloud_h00485561_01", "op_time" : "1699325617000", "plugin_composition_type" : "single", "plugin_attribution" : "custom", "workspace_id" : "ce8df55870164338a72d7e828a966a2a", "business_type" : "Gate", "business_type_display_name" : "代码检查", "maintainers" : "", "icon_url" : "", "refer_count" : null, "usage_count" : null, "runtime_attribution" : "agent", "active" : 1 } ] }
  • 请求示例 POST https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/agent-plugin/query-all?offset=0&limit=3 { "plugin_name" : "", "maintainer" : "", "business_type" : [ "Build", "Gate", "Deploy", "Test", "Normal" ], "plugin_attribution" : "custom" }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 offset Integer 偏移 limit Integer 大小 total Integer 总数 data Array of PluginBasicVO objects 结果集 表6 PluginBasicVO 参数 参数类型 描述 plugin_name String 插件名 display_name String 展示名 version String 版本 version_description String 版本说明 description String 描述 version_attribution String 版本属性 unique_id String 唯一ID op_user String 操作人 op_time String 操作时间 plugin_composition_type String 组合类型 plugin_attribution String 属性 workspace_id String 租户ID business_type String 业务类型 business_type_display_name String 业务类型展示名 maintainers String 维护者 icon_url String 图标URL refer_count Integer 引用次数 usage_count Integer 使用次数 runtime_attribution String 运行属性 active Integer 是否激活 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 error_code String 错误码
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表4 请求Body参数 参数 是否必选 参数类型 描述 plugin_name 否 String 插件名 regex_name 否 String 名称 maintainer 否 String 维护者 business_type 否 Array of strings 业务类型 plugin_attribution 否 String 属性
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数 data Array of SimpleOpenSourceRuleSetVO objects 开源治理策略列表 表5 SimpleOpenSourceRuleSetVO 参数 参数类型 描述 id String 开源治理策略ID name String 开源治理策略名称 level String 开源治理策略级别(tenant-租户级,project-项目级) is_valid Boolean 是否可用 version String 版本 operator String 操作人 is_public Boolean 是否系统策略 is_legacy Boolean 是否老版 operate_time Long 操作时间 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 error_code String 错误码
  • URI GET /v2/{domain_id}/tenant/open-source/rule-sets/query 表1 路径参数 参数 是否必选 参数类型 描述 domain_id 是 String 租户ID 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 策略名称 creator_name 否 String 策略创建人名称 limit 否 Integer 分页参数,默认15 offset 否 Integer 分页参数,默认0
  • 响应示例 状态码: 200 OK { "data" : [ { "id" : "883f1208ab0048e9aae21a10160982e8", "name" : "APITest测试_4fNOVk", "level" : "tenant", "is_valid" : true, "version" : "2adaff1dea3f477e918c9629be900356", "operator" : "devcloud_xxx", "is_public" : false, "is_legacy" : null, "operate_time" : 1684987087000 }, { "id" : "17fcabdb890c4342a66349cc74e4115a", "name" : "APITest测试_92A6dQ", "level" : "tenant", "is_valid" : true, "version" : "dc0c2354e7e140959a9fa26119ad558c", "operator" : "devcloud_xxx", "is_public" : false, "is_legacy" : null, "operate_time" : 1684986715000 }, { "id" : "edb7794d28994f5183ac2bd724665e5d", "name" : "CreatePolicy-20230524110450", "level" : "tenant", "is_valid" : true, "version" : "5d88f49a589a44cf9becaf75e72c4922", "operator" : "devcloud_xxx", "is_public" : false, "is_legacy" : null, "operate_time" : 1684897626000 }, { "id" : "3531812b8c7e4708bcb663c0a454d87b", "name" : "NewOsgPolicy-20230524100437", "level" : "tenant", "is_valid" : true, "version" : "4f869bd73e924d639758391d6daa777d", "operator" : "devcloud_xxx", "is_public" : false, "is_legacy" : null, "operate_time" : 1684897136000 }, { "id" : "c80f598200eb422084ce1f4ebd79d9e5", "name" : "创建开源治理策略-20230523110532", "level" : "tenant", "is_valid" : true, "version" : "25244e5a9b30453aa3d3f89f42f6a1ad", "operator" : "devcloud_xxx", "is_public" : false, "is_legacy" : null, "operate_time" : 1684811168000 }, { "id" : "da394b4c0d5c48698773afc7642e300a", "name" : "创建开源治理策略-20230523110517", "level" : "tenant", "is_valid" : true, "version" : "35f41b393a49423abe9909ba11fb166d", "operator" : "devcloud_xxx", "is_public" : false, "is_legacy" : null, "operate_time" : 1684811120000 }, { "id" : "c1824854160b4a24b3b138da804e8dd1", "name" : "创建开源治理策略-20230523110411", "level" : "tenant", "is_valid" : true, "version" : "49b02b100e77481caaae98d4b937f794", "operator" : "devcloud_xxx", "is_public" : false, "is_legacy" : null, "operate_time" : 1684811056000 }, { "id" : "883397de70e54ff7ad5004a79f727fb2", "name" : "APITest测试_wfm5lq", "level" : "tenant", "is_valid" : true, "version" : "7dc702f60e4741adad0c460a3a120406", "operator" : "devcloud_xxx", "is_public" : false, "is_legacy" : null, "operate_time" : 1684756995000 }, { "id" : "968c76ef5d704e62ad0ae812a34c03d2", "name" : "cjrTest--租户级", "level" : "tenant", "is_valid" : true, "version" : "c79cfa5fc11b456f8d22592a87815c9f", "operator" : "devcloud_xxx", "is_public" : false, "is_legacy" : null, "operate_time" : 1684722851000 } ], "total" : 29 }
  • 响应示例 状态码: 200 OK { "offset" : 0, "limit" : 10, "total" : 3, "data" : [ { "publisher_unique_id" : "7f1c6b0f12f94b3d9e37eee0b541d3ac", "user_id" : "847a5317086c41798469d0868535943a", "tenant_id" : "ce8df55870164338a72d7e828a966a2a", "description" : "", "logo_url" : "", "website" : "", "support_url" : "aaa@aa.com", "source_url" : "", "en_name" : "aaa", "name" : "aaa", "auth_status" : "processing", "is_delete" : 0, "last_update_user_name" : "devcloud_devcloud_h00485561_01", "last_update_user_id" : "847a5317086c41798469d0868535943a", "last_update_time" : "2023-11-07T18:54:02.411" }, { "publisher_unique_id" : "4ea3d6eb6f9d40e681d7b555161dffc2", "user_id" : "d61bdd3214a441b6ad630ce8a9c1015a", "tenant_id" : "ce8df55870164338a72d7e828a966a2a", "description" : "", "logo_url" : "", "website" : "", "support_url" : "fgddf", "source_url" : "", "en_name" : "dfdg", "name" : "fdfg", "auth_status" : "processing", "is_delete" : 0, "last_update_user_name" : "devcloud_devcloud_h00485561_01/SysReservedV3_pipel", "last_update_user_id" : "d61bdd3214a441b6ad630ce8a9c1015a", "last_update_time" : "2023-10-31T14:18:06.356" }, { "publisher_unique_id" : "b9fc8fb6d9194536ac66dd74c2212126", "user_id" : "847a5317086c41798469d0868535943a", "tenant_id" : "ce8df55870164338a72d7e828a966a2a", "description" : "这里是描述", "logo_url" : "/api/v1/ce8df55870164338a72d7e828a966a2a/common/get-plugin-icon?object_key=default-cfb6036d13404631a04a5e7f3a5899b2-kubernetes.png-ce8df55870164338a72d7e828a966a2a&icon_type=publish", "website" : "https://tinydesign.cloudbu.huawei.com/rp/team/ptnixbayoz", "support_url" : "5555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555", "source_url" : "", "en_name" : "kejiyouxiangongsi", "name" : "杭州XXX科技有限公司", "auth_status" : "accept", "is_delete" : 0, "last_update_user_name" : "devcloud_devcloud_h00485561_01", "last_update_user_id" : "847a5317086c41798469d0868535943a", "last_update_time" : "2023-02-21T09:22:34.528" } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 offset Integer 查询偏移量 limit Integer 每次查询的条目数量 total Long 查询总数 data Array of PublisherVO objects 数据列表 表5 PublisherVO 参数 参数类型 描述 publisher_unique_id String 发布商ID user_id String 用户ID tenant_id String 租户ID description String 描述 logo_url String 图标URL website String 网页地址 support_url String 地址 source_url String 地址 en_name String 英文名 name String 名称 auth_status String 授权状态 is_delete Integer 是否删除 last_update_user_name String 最后更新人 last_update_user_id String 最后更新人ID last_update_time String 最后更新时间 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 error_code String 错误码
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 pipeline_id String 流水线ID pipeline_name String 流水线名称 executor String 执行人 build_id String 流水线执行ID start_time String 开始执行时间 end_time String 结束执行时间 parameters Array of PipelineParameter objects 流水线参数 states Array of PipelineStateStatus objects 流水线执行情况 elapsed_time String 执行耗时 status String 流水线运行状态.取值和含义:waiting:等待;running:执行中;verifying:待审核;suspending:挂起;completed:完成 outcome String 流水线执行结果。取值及含义:success:成功;error:失败;aborted:终止 detail_url String 流水线详情页地址 表5 PipelineParameter 参数 参数类型 描述 name String 参数名称 value String 参数值 表6 PipelineStateStatus 参数 参数类型 描述 id String 阶段或任务标识 name String 阶段或任务名称 type String 类别(阶段/任务) start_time String 执行开始时间 end_time String 执行结束时间 elapsed_time String 运行耗时 status String 运行状态.取值和含义:waiting:等待;running:执行中;verifying:待审核;suspending:挂起;completed:完成 outcome String 运行结果。取值及含义:success:成功;error:失败;aborted:终止 error_code String 错误码 error_msg String 错误信息 children Array of PipelineStateStatus objects 子任务运行信息(对任务来说是空的) detail_url String 任务运行记录跳转链接 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 error_code String 错误码
  • 响应示例 状态码: 200 OK { "executor" : null, "status" : null, "outcome" : null, "pipeline_id" : "75c562a081574ff28224fb2c123a0643", "pipeline_name" : "pipeline-1185523_Cx2Ur", "build_id" : null, "start_time" : "2022-04-01 19:44:16", "end_time" : null, "elapsed_time" : null, "detail_url" : "https://xxx", "parameters" : [ { "name" : "seviceName", "value" : "pipeline-23" }, { "name" : "codeBranch", "value" : "master" } ], "states" : [ { "id" : "state_4", "name" : "构建", "type" : "stage", "status" : null, "outcome" : null, "children" : [ { "id" : "Task_1", "name" : "人工审核", "type" : "task", "status" : null, "outcome" : null, "start_time" : null, "end_time\"" : null, "elapsed_time" : null, "error_code" : null, "error_msg" : null, "detail_url" : null } ], "start_time" : null, "end_time" : null, "elapsed_time" : null } ] }
  • URI PUT /v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/{pipeline_run_id}/retry 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID pipeline_id 是 String 流水线ID pipeline_run_id 是 String 流水线运行实例ID
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 unique_id 否 String 唯一ID icon_url 否 String 图标URL runtime_attribution 否 String 运行属性 plugin_name 否 String 插件名 display_name 否 String 展示名 business_type 否 String 业务类型 business_type_display_name 否 String 业务类型展示名 description 否 String 描述 is_private 否 Integer 是否私有 region 否 String 局点 maintainers 否 String 维护者 version 否 String 版本号 version_description 否 String 版本号说明 execution_info 否 execution_info object 执行信息 input_info 否 Array of input_info objects 输入信息 表4 execution_info 参数 是否必选 参数类型 描述 inner_execution_info 否 Object 执行信息 表5 input_info 参数 是否必选 参数类型 描述 name 否 String 名称 default_value 否 String 默认值 type 否 String 输入类型 validation 否 String 验证 layout_content 否 String 样式信息
  • 请求示例 POST https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/agent-plugin/create { "plugin_name" : "apie_test", "display_name" : "apie_test", "version" : "0.0.2", "version_description" : "", "description" : "", "unique_id" : "ab43c83c2ae04000afd039ad894e953b", "business_type" : "Normal", "business_type_display_name" : "通用", "icon_url" : "", "runtime_attribution" : "agent", "input_info" : [ ], "execution_info" : { "inner_execution_info" : { "execution_type" : "COMPOSITE", "steps" : [ { "task" : "official_shell_plugin", "name" : "执行Shell", "identifier" : "16993543666638cda5035-4854-4bc8-a88a-e1465b1bcc7a", "variables" : { "OFFICIAL_SHELL_SCRIPT_INPUT" : "env" } } ] } } }
  • URI GET /v2/{project_id}/open-source/rule-sets/query 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 策略名称 creator_name 否 String 策略创建人名称 include_tenant_rule_set 是 Boolean 是否包含当前项目所属租户的策略 limit 否 Integer 分页参数,默认15 offset 否 Integer 分页参数,默认0
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数 data Array of SimpleOpenSourceRuleSetVO objects 开源治理策略列表 表5 SimpleOpenSourceRuleSetVO 参数 参数类型 描述 id String 开源治理策略ID name String 开源治理策略名称 level String 开源治理策略级别(tenant-租户级,project-项目级) is_valid Boolean 是否可用 version String 版本 operator String 操作人 is_public Boolean 是否系统策略 is_legacy Boolean 是否老版 operate_time Long 操作时间 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 error_code String 错误码
  • 响应示例 状态码: 200 OK { "data" : [ { "id" : "60eab9fd2b144f619a3563b2e0036a61", "name" : "创建开源治理策略-20231020154413", "level" : "project", "is_valid" : true, "version" : "a108f6b1effb4b03a9505288f8801e65", "operator" : "devcloud_xxx", "is_public" : false, "is_legacy" : null, "operate_time" : 1697787881000 } ], "total" : 1 }
  • 响应示例 状态码: 200 OK { "plugin_name" : "apie_test", "display_name" : "apie_test222", "op_user" : "devcloud_devcloud_h00485561_01", "op_time" : "1699358542000", "version" : "0.0.4", "unique_id" : "036d51108a0b48eeb876fb6341ee7615", "version_description" : "", "version_attribution" : "formal", "plugin_composition_type" : "multi", "plugin_attribution" : "custom", "input_info" : [ ], "plugin_execution" : { "logic_id" : "", "plugin_name" : "apie_test", "version" : "0.0.4", "basic_instance_id" : "036d51108a0b48eeb876fb6341ee7615", "workspace_id" : "ce8df55870164338a72d7e828a966a2a", "execution_type" : "COMPOSITE", "steps" : [ { "name" : "执行Shell", "task" : "official_shell_plugin", "variables" : { "OFFICIAL_SHELL_SCRIPT_INPUT" : "env" } } ] }, "runtime_attribution" : "agent" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 plugin_name String 插件名 display_name String 展示名 op_user String 操作人 op_time String 操作时间 version String 版本 unique_id String 唯一ID version_description String 版本说明 version_attribution String 版本属性 plugin_composition_type String 组合插件类型 plugin_attribution String 插件属性 input_info Array of input_info objects 输入信息 plugin_execution Object 执行信息 runtime_attribution String 运行属性 表5 input_info 参数 参数类型 描述 unique_id String 唯一ID name String 名称 default_value String 默认值 plugin_name String 插件名 version String 版本 type String 类型 workspace_id String 租户ID validation ExtensionValidation object 验证 layout_content String 样式信息 表6 ExtensionValidation 参数 参数类型 描述 required_message String 消息 regex String 正则 regex_message String 正则消息 max_length Integer 最大长度 min_length Integer 最小长度 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 error_code String 错误码
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 status Boolean 状态 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 请求示例 PUT https://{endpoint}/v2/ce8df55870164338a72d7e828a966a2a/tenant/rule-sets/6cb18ee5ca1c48caa335706e0e5ee288/update { "name" : "创建一个租户级策略", "rules" : [ { "id" : "097f315044244c9193f1e3f1fba7979d", "is_valid" : true }, { "id" : "80cfcff078074b8aa7951d7b67b3137b", "is_valid" : true } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 规则模版实例名称 rules 否 Array of UpdateRuleInstance objects 规则实例列表 表4 UpdateRuleInstance 参数 是否必选 参数类型 描述 id 否 String 规则实例ID is_valid 否 Boolean 规则实例状态
共100000条