华为云用户手册

  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 task_id String 流水线创建实例ID task_status String 实例创建状态,取值和含义:initializing:初始化中;processing:处理中;finished:已完成;succeeded:成功 pipeline_id String 流水线ID pipeline_name String 流水线名称 pipeline_url String 流水线详情页面url 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 error_code String 错误码
  • 响应示例 状态码: 200 OK { "task_id" : "eafaff0bf9094d3d8456d13dddf67b40", "task_status" : "succeeded", "pipeline_id" : "4f73c81f5d98455eab7a2fda2f3d2434", "pipeline_name" : "pipeline-20200316144601", "pipeline_url" : "https://xxx/3560a08e3c5143c5bb0236e0ef910926/pipeline/detail/4f73c81f5d98455eab7a2fda2f3d2434" }
  • URI POST /v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/{pipeline_run_id}/stop 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID pipeline_id 是 String 流水线ID pipeline_run_id 是 String 流水线运行实例ID
  • 请求示例 POST https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/agent-plugin/create-draft { "plugin_name" : "apie_test", "display_name" : "apie_test", "business_type" : "Normal", "description" : "", "maintainers" : "", "business_type_display_name" : "通用", "icon_url" : "", "version" : "0.0.1", "version_description" : "", "input_info" : [ ], "execution_info" : { "inner_execution_info" : { "execution_type" : "COMPOSITE", "steps" : [ { "task" : "official_shell_plugin", "name" : "执行Shell", "identifier" : "16993543005962cb6e5e8-458a-4382-adfe-9702345ecddb", "variables" : { "OFFICIAL_SHELL_SCRIPT_INPUT" : "env" } } ] } }, "runtime_attribution" : "agent" }
  • 请求参数 表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 样式信息
  • 请求参数 表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}/v3/ce8df55870164338a72d7e828a966a2a/extension/info/add { "plugin_name" : "basic_plugin", "display_name" : "basic_plugin", "business_type" : "Normal", "description" : "", "maintainers" : "", "business_type_display_name" : "通用", "icon_url" : "", "plugin_composition_type" : "single" }
  • 响应示例 状态码: 200 OK [ { "result" : "error", "status" : "completed", "stages" : [ { "result" : "success", "status" : "completed", "name" : "initial", "parameters" : null, "order" : 1, "dsl_method" : "initial", "display_name" : "源代码" }, { "result" : "success", "status" : "completed", "name" : "state_3", "parameters" : null, "order" : 2, "dsl_method" : "build", "display_name" : "构建" } ], "executor" : "devcloud_xxx", "pipeline_name" : "PipelineSvc测试勿删_继续执行", "pipeline_id" : "92a65e2337174fabbdbccda97ab7ffad", "detail_url" : "https://xxxxx", "modify_url" : "https://xxxxxx", "start_time" : "2022-09-09 00:00:00", "end_time" : "2022-09-09 00:00:24", "build_id" : "25" } ]
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 [数组元素] Array of PipelineExecuteStates objects OK 表4 PipelineExecuteStates 参数 参数类型 描述 result String 流水线执行结果。取值及含义:success:成功;error:失败;aborted:终止 status String 流水线执行状态.取值和含义:waiting:等待;running:执行中;verifying:待审核;suspending:挂起;completed:完成 stages Array of Stages objects 阶段执行情况 executor String 执行人 pipeline_name String 流水线名字 pipeline_id String 流水线ID build_id String 流水线执行ID detail_url String 流水线详情页URL modify_url String 流水线编辑页URL start_time String 开始执行时间 end_time String 结束执行时间 表5 Stages 参数 参数类型 描述 result String 阶段执行结果。取值及含义:success:成功;error:失败;aborted:终止 status String 阶段执行状态。取值和含义:waiting:等待;running:执行中;verifying:待审核;suspending:挂起;completed:完成 name String 阶段名字 parameters Object 阶段运行参数 order Integer 阶段顺序 dsl_method String 阶段类型 display_name String 阶段显示名称 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 error_code String 错误码
  • 请求示例 启动流水线。 指定启动时的运行参数为”ServiceName:pipeline-Test”和”version:1.0.0”。 { "build_params" : [ { "name" : "ServiceName", "value" : "pipeline-Test" }, { "name" : "version", "value" : "1.0.0" } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 build_params 否 Array of StartPipelineBuildParams objects 启动流水线时的构建参数 表4 StartPipelineBuildParams 参数 是否必选 参数类型 描述 name 是 String 构建参数名 value 是 String 构建参数值,最大长度为8192
  • URI GET /v2/{domain_id}/tenant/rule-sets/query 表1 路径参数 参数 是否必选 参数类型 描述 domain_id 是 String 租户ID 表2 Query参数 参数 是否必选 参数类型 描述 offset 是 Integer 偏移量,表示从此偏移量开始查询,offset大于等于0 limit 是 Integer 每页显示的条目数量 include_tenant_rule_set 是 Boolean 是否包含租户级规则 name 否 String 策略名称,用于模糊查询 is_valid 否 Boolean 是否有效 type 否 String 规则集类型 cloud_project_id 否 String 项目ID
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data Array of RuleSet objects 规则实例列表 total Long 总数 表5 RuleSet 参数 参数类型 描述 id String 规则模版实例ID name String 规则模版实例名称 type String 类型 version String 版本 operator String 最近操作人 operate_time Long 最近操作时间 is_valid Boolean 是否生效 level String 租户级、项目级 is_public Boolean 是否系统级 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 error_code String 错误码
  • 响应示例 状态码: 200 OK { "data" : [ { "id" : "30782f30c92e4c1dbc3c596075970d67", "name" : "DJtest创建租户级策略-apitest-rKaG", "level" : "tenant", "is_valid" : true, "version" : "67e915e472554f719abe513c28728d9f", "operator" : "devcloud_xxx", "is_public" : false, "operate_time" : 1692695390000 }, { "id" : "4f5fb96022974a2781174584f799d8c2", "name" : "DJtest创建租户级策略-apitest-S190", "level" : "tenant", "is_valid" : true, "version" : "61ebfef577c34406b5647ac1d83e7bb8", "operator" : "devcloud_xxx", "is_public" : false, "operate_time" : 1692695390000 } ], "total" : 333 }
  • 响应示例 状态码: 200 OK { "offset" : 0, "limit" : 3, "total" : 19, "templates" : [ { "id" : "e908740fe06e44a28f30c0f3c81b2ad5", "name" : "Serverless-maven编译部署", "icon" : "maven60", "manifest_version" : "3.0", "language" : "Java", "description" : "Serverless-maven编译构建、打包部署模板", "is_system" : true, "region" : "system", "domain_id" : "system", "creator_id" : "system", "creator_name" : "system", "updater_id" : "e908740fe06e44a28f30c0f3c81b2ad5", "create_time" : 1671172288000, "update_time" : 1677640980000, "is_collect" : true, "is_show_source" : null, "stages" : [ { "name" : "构建和检查", "sequence" : 0 }, { "name" : "部署和测试", "sequence" : 1 } ] }, { "id" : "ac3b3b9a6cb64ef6b732c8f8459ab578", "name" : "Node构建容器镜像", "icon" : "npm60", "manifest_version" : "3.0", "language" : "Node.js", "description" : "使用Node构建容器镜像,推送到SWR存储", "is_system" : true, "region" : "system", "domain_id" : "system", "creator_id" : "system", "creator_name" : "system", "updater_id" : "ac3b3b9a6cb64ef6b732c8f8459ab578", "create_time" : 1671172288000, "update_time" : 1677640980000, "is_collect" : true, "is_show_source" : null, "stages" : [ { "name" : "构建", "sequence" : 0 } ] }, { "id" : "8ea4d170ba0d45d9b1b647a9780ebcf8", "name" : "新手上路", "icon" : null, "manifest_version" : "3.0", "language" : "java", "description" : "流水线新手体验模板", "is_system" : true, "region" : "system", "domain_id" : "system", "creator_id" : "system", "creator_name" : "system", "updater_id" : "ac3b3b9a6cb64ef6b732c8f8459ab578", "create_time" : 1680769082000, "update_time" : 1680770243000, "is_collect" : false, "is_show_source" : null, "stages" : [ { "name" : "代码检查", "sequence" : 0 }, { "name" : "构建阶段", "sequence" : 1 }, { "name" : "部署发布", "sequence" : 2 } ] } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 offset Integer 起始偏移 limit Integer 每页大小 total Integer 总数 templates Array of PipelineTemplateSimpleVO objects 流水线模板列表 表4 PipelineTemplateSimpleVO 参数 参数类型 描述 id String 模板ID name String 模板名称 icon String 模板图标 manifest_version String 版本 language String 模板语言 description String 模板描述 is_system Boolean 是否系统模板 region String 模板局点 domain_id String 模板所属租户ID creator_id String 模板创建人ID creator_name String 模板创建人名称 updater_id String 模板更新人ID create_time Integer 创建时间 update_time Integer 更新时间 is_collect Boolean 是否收藏 is_show_source String 是否展示流水线源 stages Array of stages objects 模板编排stages 表5 stages 参数 参数类型 描述 name String 阶段名称 sequence Integer 阶段顺序 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 error_code String 错误码
  • 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 language 否 String 模板语言 is_system 否 Boolean 是否系统模板 name 否 String 模板名称 offset 否 Long 偏移量,表示从此偏移量开始查询,offset大于等于0,默认为0 limit 否 Long 每次查询的条目数量。 sort_key 否 String 用于排序的字段,非必选。取值为:name, create_time sort_dir 否 String 排序类型,非必选。asc按排序字段升序,desc按排序字段降序
  • 请求示例 POST https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/agent-plugin/publish-draft { "plugin_name" : "testteset", "display_name" : "testteset", "version" : "0.0.1", "plugin_attribution" : "custom" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 plugin_name 否 String 插件名 display_name 否 String 展示名 version 否 String 版本号 plugin_attribution 否 String 插件属性 version_attribution 否 String 版本属性
  • 请求示例 获取流水线列表。 指定查询的项目ID为”e12ed176898d4841aa9881fe9b933c87”,创建人ID为”847a5317086c41798469d0868535943a”,并根据流水线名称降序排序。 POST https://{endpoint}/v3/pipelines/list { "pipeline_name" : "", "project_ids" : "e12ed176898d4841aa9881fe9b933c87", "creator_ids" : "847a5317086c41798469d0868535943a", "executor_ids" : "847a5317086c41798469d0868535943a", "status" : "waiting,running,verifying,handling,suspending,completed", "outcome" : "error,success,aborted", "sort_key" : "pipeline_name", "sort_dir" : "desc", "git_url" : "", "offset" : 4, "limit" : 10 }
  • 响应示例 状态码: 200 OK { "offset" : 0, "limit" : 10, "total" : 88, "result" : [ { "project_id" : "e12ed176898d4841aa9881fe9b933c87", "project_name" : "Pipeline_Beta_自动测试", "pipeline_id" : "d33f98177c3e44f8841b005e1badcaed", "pipeline_name" : "马云多仓", "creator_id" : "847a5317086c41798469d0868535943a", "creator_name" : "大Beta测试账号", "executor_id" : "847a5317086c41798469d0868535943a", "executor_name" : "大Beta测试账号", "start_time" : "2022-09-08 17:08:02", "create_time" : "2022-07-28 17:02:11", "watched" : "true" }, { "project_id" : "e12ed176898d4841aa9881fe9b933c87", "project_name" : "Pipeline_Beta_自动测试", "pipeline_id" : "2ec08a45031c4d2896292a48b7fb1a30", "pipeline_name" : "门禁专用测试_勿删", "creator_id" : "847a5317086c41798469d0868535943a", "creator_name" : "大Beta测试账号", "executor_id" : "847a5317086c41798469d0868535943a", "executor_name" : "大Beta测试账号", "start_time" : "2022-09-08 16:52:03", "create_time" : "2020-10-29 17:05:02", "watched" : "true" } ] }
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表2 请求Body参数 参数 是否必选 参数类型 描述 pipeline_name 否 String 流水线名字。查询时进行模糊匹配。 project_ids 否 String 项目id,有多个值时用逗号分隔,id个数取值[0,10],非必选。如果该参数有值,则获取对应项目下的流水线列表;如果没有值,则获取用户有权限的所有项目的流水线列表 creator_ids 否 String 创建人id,有多个值时用逗号分隔,id个数取值[0,10],非必选 executor_ids 否 String 执行人id。有多个值时用逗号分隔,id个数取值[0,10],非必选 status 否 String 流水线运行状态.取值和含义:waiting:等待;running:执行中;verifying:待审核;suspending:挂起;completed:完成 outcome 否 String 流水线执行结果。取值及含义:success:成功;error:失败;aborted:终止 sort_key 否 String 用于排序的字段。取值为:pipeline_name,create_time,start_time sort_dir 否 String 排序方式。asc按排序字段升序,desc按排序字段降序 git_url 否 String 代码仓地址。仅支持codehub仓库,如:git@codehub.XXX.git offset 否 Integer 偏移量。表示从此偏移量开始查询,offset大于等于0,默认取值为0 limit 否 Integer 每次查询的条目数量。取值[10-50],默认取值为10
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 offset Integer 偏移量,表示从此偏移量开始查询,offset大于等于0 limit Integer 每次查询的条目数量 total Integer 总条目数量 result Array of PipelineBasicInfo objects 流水线列表 表4 PipelineBasicInfo 参数 参数类型 描述 project_id String 项目id project_name String 项目名称 pipeline_id String 流水线id pipeline_name String 流水线名称 creator_id String 流水线创建人id creator_name String 流水线创建人名字 executor_id String 流水线执行人id executor_name String 流水线执行人名字 start_time String 启动时间 create_time String 创建时间 watched String 用户是否关注流水线:true(关注),false(未关注) 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 error_code String 错误码
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 [数组元素] Array of PipelineGroupVo objects OK 表4 PipelineGroupVo 参数 参数类型 描述 id String 分组ID domain_id String 租户ID project_id String 项目ID name String 分组名 parent_id String 父分组ID path_id String 分组路径ID ordinal Integer 序号 creator String 创建用户ID updater String 更新用户ID create_time Long 创建时间 update_time Long 更新时间 children Array of PipelineGroupVo objects 子分组列表 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 error_code String 错误码
  • 响应示例 状态码: 200 OK [ { "id" : "894daf0db79c4ccb839490770fa06596", "domain_id" : "ce8df55870164338a72d7e828a966a2a", "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec", "name" : "新建分组22", "parent_id" : "", "path_id" : "894daf0db79c4ccb839490770fa06596", "ordinal" : 2, "creator" : "847a5317086c41798469d0868535943a", "updater" : null, "create_time" : 1698487536000, "update_time" : null, "children" : null }, { "id" : "2ca78947b25847a9ab68a07d8ef1347b", "domain_id" : "ce8df55870164338a72d7e828a966a2a", "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec", "name" : "新建分组11", "parent_id" : "", "path_id" : "2ca78947b25847a9ab68a07d8ef1347b", "ordinal" : 1, "creator" : "847a5317086c41798469d0868535943a", "updater" : null, "create_time" : 1698487008000, "update_time" : null, "children" : null }, { "id" : "58d55f8a646443a984e7399632b3963e", "domain_id" : "ce8df55870164338a72d7e828a966a2a", "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec", "name" : "G2", "parent_id" : "", "path_id" : "58d55f8a646443a984e7399632b3963e", "ordinal" : 0, "creator" : "847a5317086c41798469d0868535943a", "updater" : "847a5317086c41798469d0868535943a", "create_time" : 1698484566000, "update_time" : 1698485674000, "children" : [ { "id" : "d805c90bf99049d3a49e83d2024df6b8", "domain_id" : "ce8df55870164338a72d7e828a966a2a", "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec", "name" : "新建分组3", "parent_id" : "58d55f8a646443a984e7399632b3963e", "path_id" : "58d55f8a646443a984e7399632b3963e.d805c90bf99049d3a49e83d2024df6b8", "ordinal" : 1, "creator" : "847a5317086c41798469d0868535943a", "updater" : "847a5317086c41798469d0868535943a", "create_time" : 1698487527000, "update_time" : 1698487868000, "children" : null }, { "id" : "ebb779b3b9f742e181b1f6829fa1aca0", "domain_id" : "ce8df55870164338a72d7e828a966a2a", "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec", "name" : "新建分组", "parent_id" : "58d55f8a646443a984e7399632b3963e", "path_id" : "58d55f8a646443a984e7399632b3963e.ebb779b3b9f742e181b1f6829fa1aca0", "ordinal" : 0, "creator" : "847a5317086c41798469d0868535943a", "updater" : null, "create_time" : 1698485344000, "update_time" : null, "children" : [ { "id" : "1b80aa3df0984e9caffefdc4e557524e", "domain_id" : "ce8df55870164338a72d7e828a966a2a", "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec", "name" : "新建分组4", "parent_id" : "ebb779b3b9f742e181b1f6829fa1aca0", "path_id" : "58d55f8a646443a984e7399632b3963e.ebb779b3b9f742e181b1f6829fa1aca0.1b80aa3df0984e9caffefdc4e557524e", "ordinal" : 2, "creator" : "847a5317086c41798469d0868535943a", "updater" : null, "create_time" : 1698487502000, "update_time" : null, "children" : null }, { "id" : "6bc8a3cda52c41fe84d71c9ff86161ea", "domain_id" : "ce8df55870164338a72d7e828a966a2a", "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec", "name" : "新建分组3", "parent_id" : "ebb779b3b9f742e181b1f6829fa1aca0", "path_id" : "58d55f8a646443a984e7399632b3963e.ebb779b3b9f742e181b1f6829fa1aca0.6bc8a3cda52c41fe84d71c9ff86161ea", "ordinal" : 1, "creator" : "847a5317086c41798469d0868535943a", "updater" : null, "create_time" : 1698486710000, "update_time" : null, "children" : null } ] } ] } ]
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 id String 策略ID name String 策略名称 level String 策略级别 parent_id String 父策略ID version String 策略版本 is_valid Boolean 是否启用 is_public Boolean 是否系统级策略 creator String 创建人 create_time String 创建时间 updater String 更新人 update_time String 更新时间 content OpenSourceRuleContent object 策略规则详情 表4 OpenSourceRuleContent 参数 参数类型 描述 version_set VersionSetProperty object 开源依赖 security SecurityProperty object 漏洞 license LicenseProperty object 许可证 表5 VersionSetProperty 参数 参数类型 描述 enable Boolean 是否启用 rules Array of VersionSetRule objects 规则列表 表6 VersionSetRule 参数 参数类型 描述 enable Boolean 是否开启 ecosystem String 依赖类型 package_name String 包名称 package_version String 包版本 description String 规则说明 predicate String 比较规则 表7 SecurityProperty 参数 参数类型 描述 enable Boolean 是否启用 rules SecurityRule object 规则详情 表8 SecurityRule 参数 参数类型 描述 severity severity object 漏洞级别 cve cve object 漏洞编号 表9 severity 参数 参数类型 描述 enable Boolean 是否启用 values Array of strings 漏洞等级 表10 cve 参数 参数类型 描述 enable Boolean 是否启用 values Array of strings 漏洞编号 表11 LicenseProperty 参数 参数类型 描述 enable Boolean 是否开启 rules Array of rules objects 规则列表 表12 rules 参数 参数类型 描述 values Array of strings license详情 predicate String 比较规则 状态码: 400 表13 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 error_code String 错误码
  • 响应示例 状态码: 200 OK { "id" : "60eab9fd2b144f619a3563b2e0036a61", "name" : "创建开源治理策略-20231020154413", "level" : "project", "version" : "a108f6b1effb4b03a9505288f8801e65", "is_valid" : true, "is_public" : false, "creator" : "847a5317086c41798469d0868535943a", "create_time" : "2023-10-20T15:44:41", "updater" : "847a5317086c41798469d0868535943a", "update_time" : "2023-10-20T15:44:41", "content" : { "version_set" : { "enable" : true, "rules" : [ { "enable" : true, "ecosystem" : "Maven", "package_name" : "springboot", "package_version" : "2.5", "description" : "", "predicate" : "eq" } ] }, "security" : { "enable" : true, "rules" : { "severity" : { "enable" : true, "values" : [ "Critical", "High", "Medium" ] }, "cve" : { "enable" : false, "values" : [ "" ] } } }, "license" : { "enable" : true, "rules" : [ { "predicate" : "contain", "values" : [ ] } ] } } }
  • 使用须知 SSL连接需要具有一定的操作权限,如需使用,请联系客服申请相应的权限。 开启或关闭SSL会导致实例重启,请谨慎操作。 开启SSL后,可以通过SSL方式连接数据库,具有更高的安全性。 出于安全原因,不安全的加密算法已被禁用。GeminiDB Mongo支持的安全加密算法对应的加密套件如表1所示。 表1 安全加密算法对应的加密套件说明 版本 支持的TLS版本 支持的加密算法套件 4.0 TLS 1.2 DHE-RSA-AES256-GCM-SHA384 DHE-RSA-AES128-GCM-SHA256 用户的客户端所在服务器需要支持对应的TLS版本以及对应的加密算法套件,否则会连接失败。 关闭SSL,可以采用非SSL方式连接数据库。
  • 操作场景 SSL(Secure Socket Layer,安全套接层),位于可靠的面向连接的网络层协议和应用层协议之间的一种协议层。SSL通过互相认证、使用数字签名确保完整性、使用加密确保私密性,以实现客户端和服务器之间的安全通讯。 认证用户和服务器,确保数据发送到正确的客户端和服务器。 加密数据以防止数据中途被窃取。 维护数据的完整性,确保数据在传输过程中不被改变。 SSL连接开启后,可以通过SSL方式连接实例,提高数据安全性。
  • 使用须知 实例状态为“正常”、“异常”、“恢复检查中”,支持重启实例。 重启实例会导致服务中断,请谨慎操作。请在业务低峰期重启,重启前请做好业务安排并确保应用有重连机制。 重启实例后,该实例下所有节点将会被重启。 开启操作保护的用户,在进行敏感操作时,通过进行二次认证再次确认您的身份,进一步提高账号安全性,有效保护您安全使用云产品。关于如何开启操作保护,具体请参考《 统一身份认证 服务用户指南》的内容。
共100000条