华为云用户手册

  • 请求示例 修改id为ba1ca687-1895-4fc3-88ca-9db02ce2a14e的泳道组的名称、描述、流量入口网关以及目标服务。 { "name": "test", "description": "test-descption", "gateways": [ { "id": "71949725-9c8f-483a-a05f-74d33ff1613e", "name": "microGateway-cy8bhr", "engine_id": "d68a5ca7-b5b6-4917-a464-0adef94b8067", "target_services": [ { "id": "8177d237-b912-4167-a90d-33c603610d0b", "host": "provider..demo-java-chassis-cse-v2.servicecomb", "name": "provider", "engine_type": "servicecomb", "engine_id": "d68a5ca7-b5b6-4917-a464-0adef94b8067" } ] } ] }
  • 响应示例 { "gateways": [ { "id": "71949725-9c8f-483a-a05f-74d33ff1613e", "name": "microGateway-cy8bhr", "target_services": [ { "id": "8177d237-b912-4167-a90d-33c603610d0b", "host": "provider..demo-java-chassis-cse-v2.servicecomb", "name": "provider", "engine_id": "d68a5ca7-b5b6-4917-a464-0adef94b8067", "engine_type": "servicecomb" } ], "engine_id": "d68a5ca7-b5b6-4917-a464-0adef94b8067", } ], "id": "ba1ca687-1895-4fc3-88ca-9db02ce2a14e", "name": "test", "gray_release_type": "WEIGHT", "description": "test-descption", "project_id": "578ac30b81034b89a7255b3af26db9c9", "creator": "test_user", "create_time": 1726623793113, "update_time": 1726623793113, "swimlanes": [ { "id": "1cd0cb71-5d5d-41a0-8b05-f7ed53400cf7", "name": "base", "swimlane_group_id": "ba1ca687-1895-4fc3-88ca-9db02ce2a14e", "type": "BASE", "tag": "base", "route_status": "ENABLE", "rule_match_mode": null, "project_id": "578ac30b81034b89a7255b3af26db9c9", "rules": null, "creator": "test_user", "create_time": 1726626094346, "update_time": 1726626094346, "instances": [ { "componentId": "c14f17b7-ac44-4738-8b57-4be7eff7a956", "environmentId": "d1b623d9-3350-4777-8979-5b4b571ca518", "id": "5fd78836-301e-4750-bdc9-be8a9e43b19a", "name": "weater-beta", "version": "2024.0914.17114", "application_id": "69993ce9-e468-3349-acb8-a30b85b17de5", "application_name": "weathermap", "status": "RUNNING", "engine_id": "d68a5ca7-b5b6-4917-a464-0adef94b8067", "runtime_stack": { "id": "656d9392-658f-4c2c-bb4f-3702a1169267", "url": "openjdk-{arch}:8-1.3.8", "type": "Java", "name": "OpenJDK8", "deploy_mode": "container", "app_spec_name": "", "version": "1.3.8", "status": "Supported", "release_note": "Fixed some security issues and bugs.", "spec": { "os": "EulerOS 2.9.8", "sdk": "OpenJDK-8u411", "digest": null }, "parameters": null, "system": null }, "replica": 1 } ], "instance_count": 1, "weight": 100, "batch_status": null, "latest_opt": null, "release_plan_id": null } ], "swimlane_count": 1, "engine_ids": [ "d68a5ca7-b5b6-4917-a464-0adef94b8067" ] }
  • 响应消息 表6 响应参数 参数 参数类型 描述 id String 泳道组ID。 name String 泳道组名称。 description String 泳道组描述。 creator String 创建人。 project_id String 租户项目ID。 gray_release_type String 灰度发布类型。 WEIGHT:基于流量比例进行全链路灰度。 CONTENT:基于内容进行全链路灰度。 gateway_engine_ids Array of String 网关目标服务引擎ID。 gateways Array of objects 目标服务列表,请参考表7。 create_time Integer 创建时间。 update_time Integer 更新时间。 swimlanes Array of objects 泳道列表,请参考表9。 表7 gateways 参数 是否必选 参数类型 描述 engine_id 是 String 目标服务引擎ID,对应于目标服务对应的服务来源所用的引擎ID。 id 是 String 网关ID。 name 是 String 网关名称。 target_services 是 Array of objects 目标服务列表,对应于网关服务管理中的服务。请参考表8。 表8 target_services 参数 参数类型 描述 host String 目标服务host信息。 host信息由目标服务的接入引擎后的微服务名、微服务所在环境名、微服务所属应用名称已经微服务接入的引擎类型组成,以点号(.)分隔。 例如,unit-controller.testing.test-application.servicecomb。unit-controller为接入引擎的微服务名称,testing为unit-controller微服务所在环境名,test-application为unit-controller微服务所属应用名称,servicecomb表示unit-controller微服务接入的是ServiceComb引擎。 name String 目标服务名称。 id String 目标服务ID。 engine_id String 引擎ID。 engine_type String 引擎类型。 servicecomb:ServiceComb引擎。 nacos:注册配置中心。 表9 swimlanes 参数 参数类型 描述 id String 泳道ID。 name String 泳道名称。 swimlane_group_id String 所属的泳道组ID。 type String 泳道类型。 BASE:基线泳道。 GRAY:灰度泳道。 tag String 泳道标签,用于根据标签来控制流量的走向。 route_status String 泳道路由状态。 ENABLE:开启路由。 DISABLED:关闭路由。 rule_match_mode String 路由规则匹配模式,当泳道组灰度类型为基于内容即gray_release_type为CONTENT时生效。 ALL:匹配所有的规则。 ANY:匹配任一规则。 rules Array of objects 路由规则,当泳道组灰度类型为基于内容即gray_release_type为CONTENT时生效。请参考表10。 weight Integer 泳道流量权重,范围在0-100之间。 当泳道组灰度类型为基于流量即gray_release_type为WEIGHT时生效。 instances Array of objects 泳道中纳管的组件列表,请参考表11。 instance_count Integer 泳道中纳管的组件个数。 latest_opt String 泳道上一步的操作。 CLONE:克隆。 UPGRADE:升级。 ROLLBACK:回滚。 CREATE:创建。 release_plan_id String 泳道上一步操作关联的发布单ID。 project_id String 项目ID。 create_time Integer 创建时间。 update_time Integer 更新时间。 creator String 创建人。 表10 rules 参数 参数类型 描述 type String 灰度匹配规则类型。当前只支持HEADER,即基于Header头进行匹配。 key String 键。 value String 值。 condition String 匹配条件。 EXACT:精确匹配。 PREFIX:前缀匹配。 REGEX:正则匹配。 表11 instances 参数 参数类型 描述 id String 应用组件实例ID。 name String 应用组件实例名称。 version String 应用组件版本号。 application_id String 应用ID。 component_id String 组件ID。 application_name String 应用名称。 status String 实例状态 engine_id String 组件关联引擎ID。 runtime_stack Object 运行时,请参考表12。 replica Integer 实例副本数。 表12 runtime_stack 参数 参数类型 描述 name String 技术栈名称。 type String 技术栈类型,支持Java、Tomcat、Nodejs、Php、Docker、Python。 当部署模式为虚机部署时,仅支持Java、Tomcat、Nodejs;容器部署上述类型都支持。 version String 技术栈版本。 deploy_mode String 部署模式。 container,容器部署。 virtualmachine,虚机部署。
  • 请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 泳道组的名称。 由大小写英文字母、数字、中划线(-)、下划线(_)组成,并以大小写英文字母开头,大小写英文字母或者数字结尾,长度为2~64个字符。 gateways 是 Array of objects 泳道组关联网关列表,全链路流量的入口。请参考表4。 description 否 String 泳道组的描述。 最大长度为128个字符。 表4 gateways 参数 是否必选 参数类型 描述 engine_id 是 String 目标服务引擎ID,对应于目标服务对应的服务来源所用的引擎ID。 id 是 String 网关ID。 name 是 String 网关名称。 target_services 是 Array of objects 目标服务列表,对应于网关服务管理中的服务。请参考表5。 表5 target_services 参数 是否必选 参数类型 描述 host 是 String 目标服务host信息。 host信息由目标服务的接入引擎后的微服务名、微服务所在环境名、微服务所属应用名称已经微服务接入的引擎类型组成,以点号(.)分隔。 例如,unit-controller.testing.test-application.servicecomb。unit-controller为接入引擎的微服务名称,testing为unit-controller微服务所在环境名,test-application为unit-controller微服务所属应用名称,servicecomb表示unit-controller微服务接入的是ServiceComb引擎。 name 否 String 目标服务名称。 id 是 String 目标服务ID。 engine_id 是 String 引擎ID。 engine_type 是 String 引擎类型。 servicecomb:ServiceComb引擎。 nacos:注册配置中心。
  • 请求示例 创建一个名为test、描述信息为test的泳道组。该泳道组绑定了名为microGateway-cy8bhr的应用网关作为流量入口网关,通过该应用网关转发流量的目标服务为接入了ServiceComb引擎的所在环境为空、所属应用名称为demo-java-chassis-cse-v2的名为provider的微服务。 { "name": "test", "description": "test", "gateways": [ { "id": "71949725-9c8f-483a-a05f-74d33ff1613e", "name": "microGateway-cy8bhr", "engine_id": "d68a5ca7-b5b6-4917-a464-0adef94b8067", "target_services": [ { "id": "8177d237-b912-4167-a90d-33c603610d0b", "host": "provider..demo-java-chassis-cse-v2.servicecomb", "name": "provider", "engine_type": "servicecomb", "engine_id": "d68a5ca7-b5b6-4917-a464-0adef94b8067" } ] } ] }
  • 响应示例 { "gateways": [ { "id": "71949725-9c8f-483a-a05f-74d33ff1613e", "name": "microGateway-cy8bhr", "target_services": [ { "id": "8177d237-b912-4167-a90d-33c603610d0b", "host": "provider..demo-java-chassis-cse-v2.servicecomb", "name": "provider", "engine_id": "d68a5ca7-b5b6-4917-a464-0adef94b8067", "engine_type": "servicecomb" } ], "engine_id": "d68a5ca7-b5b6-4917-a464-0adef94b8067" } ], "id": "ba1ca687-1895-4fc3-88ca-9db02ce2a14e", "name": "test", "gray_release_type": "WEIGHT", "description": "test", "project_id": "578ac30b81034b89a7255b3af26db9c9", "creator": "test_user", "create_time": 1726623793113, "update_time": 1726623793113, "gateway_engine_ids": [ "d68a5ca7-b5b6-4917-a464-0adef94b8067" ] }
  • 响应消息 表6 响应参数 参数 参数类型 描述 name String 泳道组的名称。 gateways Array of objects 流量网关入口,请参考表7。 description String 泳道组的描述。 gray_release_type String 灰度发布类型。 WEIGHT:基于流量比例进行全链路灰度。 CONTENT:基于内容进行全链路灰度。 id String 泳道组的ID。 gateway_engine_ids Array of String 网关ID列表。 creator String 创建者。 create_time String 创建时间。 update_time String 更新时间 project_id String 租户项目ID。 表7 gateways 参数 参数类型 描述 engine_id String 目标服务引擎ID,对应于目标服务对应的服务来源所用的引擎ID。 id String 网关ID。 name String 网关名称。 target_services Array of objects 目标服务列表,对应于网关服务管理中的服务。请参考表8。 表8 target_services 参数 参数类型 描述 host String 目标服务host信息。 host信息由目标服务的接入引擎后的微服务名、微服务所在环境名、微服务所属应用名称已经微服务接入的引擎类型组成,以点号(.)分隔。 例如,unit-controller.testing.test-application.servicecomb。unit-controller为接入引擎的微服务名称,testing为unit-controller微服务所在环境名,test-application为unit-controller微服务所属应用名称,servicecomb表示unit-controller微服务接入的是ServiceComb引擎。 name String 目标服务名称。 id String 目标服务ID。 engine_id String 引擎ID。 engine_type String 引擎类型。 servicecomb:ServiceComb引擎。 nacos:注册配置中心。
  • 请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 泳道组的名称。 由大小写英文字母、数字、中划线(-)、下划线(_)组成,并以大小写英文字母开头,大小写英文字母或者数字结尾,长度为2~64个字符。 gateways 否 Array of objects 泳道组关联网关列表,全链路流量的入口。请参考表4。 description 否 String 泳道组的描述信息。 最大长度为128个字符。 表4 gateways 参数 是否必选 参数类型 描述 engine_id 是 String 目标服务引擎ID,对应于目标服务对应的服务来源所用的引擎ID。 id 是 String 网关ID。 name 否 String 网关名称。 target_services 是 Array of objects 目标服务列表,对应于网关服务管理中的服务。请参考表5。 表5 target_services 参数 是否必选 参数类型 描述 host 是 String 目标服务host信息。 host信息由目标服务的接入引擎后的微服务名、微服务所在环境名、微服务所属应用名称已经微服务接入的引擎类型组成,以点号(.)分隔。 例如,unit-controller.testing.test-application.servicecomb。unit-controller为接入引擎的微服务名称,testing为unit-controller微服务所在环境名,test-application为unit-controller微服务所属应用名称,servicecomb表示unit-controller微服务接入的是ServiceComb引擎。 name 否 String 目标服务名称。 id 是 String 目标服务ID。 engine_id 是 String 引擎ID。 engine_type 是 String 引擎类型。 servicecomb:ServiceComb引擎。 nacos:注册配置中心。
  • 请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考获取用户Token。
  • 响应示例 { "gateways": [ { "id": "71949725-9c8f-483a-a05f-74d33ff1613e", "name": "microGateway-cy8bhr", "target_services": [ { "id": "8177d237-b912-4167-a90d-33c603610d0b", "host": "provider..demo-java-chassis-cse-v2.servicecomb", "name": "provider", "engine_id": "d68a5ca7-b5b6-4917-a464-0adef94b8067", "engine_type": "servicecomb" } ], "engine_id": "d68a5ca7-b5b6-4917-a464-0adef94b8067" } ], "id": "ba1ca687-1895-4fc3-88ca-9db02ce2a14e", "name": "test", "gray_release_type": "WEIGHT", "description": "test-descption", "project_id": "578ac30b81034b89a7255b3af26db9c9", "creator": "test_user", "create_time": 1726623793113, "update_time": 1726623793113, "swimlanes": [ { "id": "1cd0cb71-5d5d-41a0-8b05-f7ed53400cf7", "name": "base", "swimlane_group_id": "ba1ca687-1895-4fc3-88ca-9db02ce2a14e", "type": "BASE", "tag": "base", "route_status": "ENABLE", "rule_match_mode": null, "project_id": "578ac30b81034b89a7255b3af26db9c9", "rules": null, "creator": "test_user", "create_time": 1726626094346, "update_time": 1726626094346, "instances": [ { "id": "5fd78836-301e-4750-bdc9-be8a9e43b19a", "name": "weater-beta", "version": "2024.0914.17114", "application_id": "69993ce9-e468-3349-acb8-a30b85b17de5", "application_name": "weathermap", "status": "RUNNING", "engine_id": "d68a5ca7-b5b6-4917-a464-0adef94b8067", "runtime_stack": { "url": "openjdk-{arch}:8-1.3.8", "type": "Java", "name": "OpenJDK8", "deploy_mode": "container", "version": "1.3.8", "status": "Supported", }, "replica": 1 } ], "instance_count": 1, "weight": 50, "latest_opt": null, "release_plan_id": null } ], "swimlane_count": 2, "engine_ids": [ "d68a5ca7-b5b6-4917-a464-0adef94b8067" ] }
  • 请求示例 修改ID为ba1ca687-1895-4fc3-88ca-9db02ce2a14e的泳道组网关路由配置。 { "gray_release_type": "WEIGHT", "swimlanes": [ { "id": "1cd0cb71-5d5d-41a0-8b05-f7ed53400cf7", "weight": 50 }, { "id": "414dccf2-3c15-47c2-8479-0337a5ccc4d9", "weight": 50 } ] }
  • 响应消息 表6 响应参数 参数 参数类型 描述 id String 泳道组ID。 name String 泳道组名称。 description String 泳道组描述。 creator String 创建人。 project_id String 项目ID。 gray_release_type String 泳道组灰度类型。 WEIGHT:基于流量比例进行全链路灰度。 CONTENT:基于内容进行全链路灰度。 engine_ids Array of String 网关目标服务引擎ID。 gateways Array of objects 目标服务列表,请参考表7。 swimlane_count Integer 泳道数量。 swimlanes Array of objects 泳道列表,请参考表9。 create_time Integer 创建时间。 update_time Integer 更新时间。 表7 gateways 参数 参数类型 描述 id String 网关ID。 name String 网关名称。 engine_id String 目标服务引擎ID,对应于目标服务对应的服务来源所用的引擎ID。 target_services Array of objects 目标服务列表,对应于网关服务管理中的服务。请参考表8。 表8 target_services 参数 参数类型 描述 id String 目标服务ID。 name String 目标服务名称。 host String 目标服务host信息。 host信息由目标服务的接入引擎后的微服务名、微服务所在环境名、微服务所属应用名称已经微服务接入的引擎类型组成,以点号(.)分隔。 例如,unit-controller.testing.test-application.servicecomb。unit-controller为接入引擎的微服务名称,testing为unit-controller微服务所在环境名,test-application为unit-controller微服务所属应用名称,servicecomb表示unit-controller微服务接入的是ServiceComb引擎。 engine_type String 引擎类型。 engine_id String 引擎ID。 表9 swimlanes 参数 参数类型 描述 id String 泳道ID。 name String 泳道名称。 swimlane_group_id String 所属的泳道组ID。 type String 泳道类型。 BASE:基线泳道。 GRAY:灰度泳道。 tag String 泳道标签,根据标签来控制流量的走向。 route_status String 泳道路由状态。 ENABLE:开启路由。 DISABLED:关闭路由。 rule_match_mode String 路由规则匹配模式。包括ALL和ANY。 ALL表示匹配所有的规则、ANY表示匹配任一规则。 当泳道组灰度类型为基于内容,即gray_release_type为CONTENT时生效。 rules Array of objects 路由规则。 当泳道组灰度类型为基于内容,即gray_release_type为CONTENT时生效。 请参考表10。 weight Integer 泳道流量权重。范围在0-100之间。 当泳道组灰度类型为基于流量,即gray_release_type为WEIGHT时生效。 instances Array of objects 泳道中纳管的组件列表。 请参考表11。 instance_count Integer 泳道中纳管的组件个数。 latest_opt String 泳道上一步的操作。 CLONE:克隆。 UPGRADE:升级。 ROLLBACK:回滚。 CREATE:创建。 release_plan_id String 泳道上一步操作关联的发布单ID。 project_id String 项目ID。 create_time Integer 创建时间。 update_time Integer 更新时间。 creator String 创建人。 表10 rules 参数 参数类型 描述 type String 灰度匹配规则类型。当前只支持HEADER,即基于Header头进行匹配。 key String 键。 value String 值。 condition String 匹配条件。 EXACT:精确匹配。 PREFIX:前缀匹配。 REGEX:正则匹配。 表11 instances 参数 参数类型 描述 id String 应用组件实例ID。 name String 应用组件实例名称。 version String 应用组件版本号。 application_id String 应用ID。 component_id String 组件ID。 application_name String 应用名称。 status String 实例状态。 engine_id String 组件关联引擎ID。 runtime_stack Object 运行时,请参考表12。 replica Integer 实例副本数。 表12 runtime_stack 参数 参数类型 描述 name String 技术栈名称。 type String 技术栈类型,支持Java、Tomcat、Nodejs、Php、Docker、Python。 当部署模式为虚机部署时,仅支持Java、Tomcat、Nodejs;容器部署上述类型都支持。 version String 技术栈版本。 deploy_mode String 部署模式。 container,容器部署。 virtualmachine,虚机部署。 url String 技术栈路径。 status String 技术栈状态。
  • 请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 gray_release_type 是 String 泳道组灰度类型。 WEIGHT:基于流量比例进行全链路灰度。 CONTENT:基于内容进行全链路灰度。 swimlanes 是 Array of objects 泳道列表,请参考表4。 表4 swimlanes 参数 是否必选 参数类型 描述 rule_match_mode 否 String 路由规则匹配模式。当泳道组灰度类型为基于内容,即gray_release_type为CONTENT时生效。 ALL:匹配所有的规则。 ANY:匹配任一规则。 rules 否 Array of objects 路由规则。当泳道组灰度类型为基于内容,即gray_release_type为CONTENT时生效。请参考表5。 weight 是 Integer 泳道流量权重,范围在0-100之间。当泳道组灰度类型为基于流量,即gray_release_type为WEIGHT时生效。 id 是 String 泳道ID。 表5 rules 参数 是否必选 参数类型 描述 type 是 String 灰度匹配规则类型。当前只支持HEADER,即基于Header头进行匹配。 key 是 String 键。 value 是 String 值。 condition 是 String 匹配条件。 EXACT:精确匹配 PREFIX:前缀匹配。 REGEX:正则匹配。
  • 响应消息 表6 响应参数 参数 参数类型 描述 application_id String 应用ID。 environment_id String 环境ID。 configuration Object 应用配置信息,请参考表7。 表7 configuration 参数 参数类型 描述 env Array of objects 应用环境变量,请参考表8。 表8 env 参数 参数类型 描述 name String 环境变量名称 value String 环境变量取值
  • 请求示例 修改应用对应环境id为0fa75dfe-0d32-4bc1-848b-8008cf3f2567的环境变量配置:名为app-env、值为env的环境变量。 { "environment_id": "0fa75dfe-0d32-4bc1-848b-8008cf3f2567", "configuration": { "env": [ { "name": "app-env", "value": "env" } ] } }
  • 响应示例 { "application_id": "06cf2fda-af45-44b4-9e22-6294c4804515", "environment_id": "0fa75dfe-0d32-4bc1-848b-8008cf3f2567", "configuration": { "env": [ { "name": "app-env", "value": "env" } ] } }
  • 请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 environment_id 是 String 环境ID,可以通过调用获取所有环境找到对应的环境获取。 configuration 是 Object 应用配置信息,如公共环境变量,请参考表4。 表4 configuration 参数 是否必选 参数类型 描述 env 是 Array of objects 应用环境变量,请参考表5。 如果多个环境变量的名称重复,则只有最后一个会生效。 表5 env 参数 是否必选 参数类型 描述 name 是 String 环境变量名称。 由字母、数字、下划线、中划线或者点号组成,不能以数字开头,且长度为1-64个字符。 value 是 String 环境变量取值。 此接口的请求参数configuration中env变量会全量覆盖应用本身已有的环境变量配置,使用时请根据是新增还是替换环境变量的场景设置此参数。
  • 请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考认证鉴权。
  • 响应示例 { "id": "0f5722ea-ee97-42bf-8583-404caa0a46e5", "project_id": "2cfeefc3e4c54a5aa7548b8350e638d7", "name": "test1", "description": "", "create_time": 1717482692680, "creator": "ss-test" }
  • 响应示例 { "id": "e5213b62-0e3c-476f-9960-3e4108787350", "name": "app-test", "description": "test", "project_id": "e7d2e9c589e5445e808a8ff0d1235aca", "enterprise_project_id": "0", "creator": "ss-test", "create_time": 1610432385245, "update_time": 1610433070875, "unified_model": null }
  • 请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 应用名称。 由大小写英文字母、数字、中划线(-)、下划线(_)组成,并以大小写英文字母开头,大小写英文字母或者数字结尾,长度为2~64个字符。 description 否 String 应用描述。 最大长度为128个字符。
  • 响应消息 表4 响应参数 参数 参数类型 描述 id String 应用ID。 name String 应用名称。 description String 应用描述。 creator String 创建人。 project_id String 项目ID。 enterprise_project_id String 企业项目ID。 create_time Integer 创建时间。 update_time Integer 修改时间。 unified_model String 是否开启统一模型,返回固定值null。
  • 响应示例 { "count": 2, "histories": [{ "config_history_id": "e9c52a5f-0f7c-48a2-b89c-29dd349d1a35", "config_id": "f5a52d93-1587-45cf-b8fe-5c7f204b98d1", "content": "testKey = valueModify", "type": "properties", "version": "v2", "create_time": 1717491574202, "components": [{ "application_id": "8a3be48a-6401-4e8c-bbce-033745252227", "component_id": "4b611997-4acd-4538-a06b-32fd2475e057", "component_name": "component-test", "environment_id": "d2d7180c-7739-4cbb-bd8e-0911ba31cf51" }], "creator": "ss-test", "group_id": "4808b50d-d7f3-401b-9175-968cb4f9892b", "config_name": "test-config1", "description": "", "sensitive": false }, { "config_history_id": "adacc5dc-a497-4023-b292-3b3cf37347f8", "config_id": "f5a52d93-1587-45cf-b8fe-5c7f204b98d1", "content": "testKey = testValue", "type": "properties", "version": "v1", "create_time": 1717491445668, "components": [{ "application_id": "8a3be48a-6401-4e8c-bbce-033745252227", "component_id": "4b611997-4acd-4538-a06b-32fd2475e057", "component_name": "component-test", "environment_id": "d2d7180c-7739-4cbb-bd8e-0911ba31cf51" }], "creator": "ss-test", "group_id": "4808b50d-d7f3-401b-9175-968cb4f9892b", "config_name": "test-config1", "description": "", "sensitive": false }] }
  • 请求消息 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考认证鉴权。
  • URI GET /v3/{project_id}/cas/configs/{config_id}/histories 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法,请参考获取项目ID。 config_id 是 String 配置文件ID。获取方法,请参考获取配置文件信息。 表2 查询参数 参数 是否必选 参数类型 描述 limit 否 integer 指定个数,取值[0, 100]。 offset 否 integer 指定偏移量。 order_by 否 String 排序字段,默认按创建时间排序。 排序字段支持枚举值: create_time,配置文件创建时间。 name,配置文件名称。 update_time,配置文件修改时间。 order 否 String 排序方式。 desc,降序排序,默认排序方式。 asc,升序排序。
  • 响应消息 表4 响应参数 参数 参数类型 描述 count Integer 配置文件历史总数。 histories Array of objects 配置文件历史列表,请参考表5。 表5 histories 参数 参数类型 描述 config_history_id String 配置文件历史ID。 config_id String 配置文件ID。 content String 配置文件历史内容。 version String 配置文件历史版本。 create_time Integer 创建时间。 components Array of objects 配置文件绑定的组件,请参考表6。 creator String 创建人。 group_id String 配置分组ID。 type String 配置文件类型。 config_name String 配置文件名称。 description String 配置文件描述。 sensitive Boolean 配置文件内容是否加密: true,加密。 false,不加密。 表6 components 参数 参数类型 描述 application_id String 应用ID。 component_id String 组件ID。 component_name String 组件名称。 environment_id String 环境ID。
  • 请求示例 通过从id为1d23eab7-da00-11ee-a1e1-0255ac1001ba的CCE中导入test-cyf-deployment工作负载,创建名为testcyf-import-deployment的无状态组件。 { "name": "testcyf-import-deployment", "description": "", "labels": [], "version": "2024.0506.16306", "environment_id": "9cff7557-4ebb-481b-bc1e-6a6573b5b8d2", "workload_name": "test-cyf-deployment", "workload_kind": "deployment", "runtime_stack": { "name": "Docker", "version": "", "type": "Docker", "deploy_mode": "container" }, "refer_resources": [{ "id": "1d23eab7-da00-11ee-a1e1-0255ac1001ba", "type": "cce", "parameters": { "namespace": "default" } }], "create_mode": "import" }
  • 请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考认证鉴权。 表3 请求Body参数 参数 是否必选 参数类型 描述 create_mode 是 String 组件创建方式。 导入CCE中已经创建的工作负载用于创建组件,该参数需要设置为import。 name 是 String 应用组件名称。 由英文字母、数字、中划线(-)、下划线(_)组成,并以英文字母开头,英文字母或者数字结尾,长度为2~64个字符。 workload_name 是 String CCE上已经创建的工作负载的名称。 labels 否 Array of objects 标签。 容器部署可通过标签查询对应工作负载,请参考表4。 runtime_stack 是 Object 运行时,固定为Docker。 environment_id 是 String 环境ID。 description 否 String 描述。 最大长度为128个字符。 version 是 String 组件版本号,最大长度32,规则为: ^([0-9]+)(.[0-9]+){2,3}$ workload_kind 是 String 工作负载类型。 deployment,无状态工作负载。 statefulset,有状态工作负载。 refer_resources 是 Array of objects 关联资源,请参考表5。 导入的工作负载需要进行微服务灰度发布时,需关联ServiceComb引擎或者Nacos引擎。 external_accesses 否 Array of Objects 外部访问,请参考表7。 表4 labels 参数 是否必选 参数类型 描述 key 否 String 标签名称。 value 否 String 标签值。 表5 refer_resources 参数 是否必选 参数类型 描述 id 是 String 资源id。 type 是 String 资源类型: vpc:虚拟私有云 eip:弹性公网IP elb:弹性负载均衡 cce:云容器引擎 dcs:分布式缓存服务 rds:云数据库 cse:ServiceComb引擎 nacos:注册配置中心 parameters 否 Object 资源参数,请参考表6。 表6 refer_resource_parameter 参数 是否必选 参数类型 描述 namespace 否 String 命名空间。 表7 external_accesses 参数 是否必选 参数类型 描述 protocol 否 String 外部访问类型,取值范围为:http、https。 address 否 String 外部访问地址。 forward_port 否 Integer 外部访问端口。
  • 响应示例 { "swimlanes" : [ { "id" : "9974a8b3-cbd7-4084-bac9-194f7d5ba3da", "name" : "gray", "swimlane_group_id" : "b76dad96-66cf-4ae7-aa55-11b6d630e777", "type" : "GRAY", "tag" : "gray", "weight" : 0, "route_status" : "DISABLED", "rule_match_mode" : null, "project_id" : "4008a952b3f44b5a919c9a48d90811f3", "rules" : null, "creator" : "test_user", "create_time" : 1722928561358, "update_time" : 1722928561358 } ], "count" : 1 }
  • 请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考获取用户Token。
共100000条
提示

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