{"base_path":null,"components":null,"consumes":"","definitions":{"AccessConfigurationDataItems":{"description":"访问方式配置项。","properties":{"access_control":{"$ref":"#/definitions/AccessControl"},"domain_names":{"description":"内网访问方式域名。","items":{"type":"string"},"type":"array"},"elb_id":{"description":"用户选择的elb的ID。","type":"string"},"metadata":{"$ref":"#/definitions/AccessConfigurationMetadata"},"operator":{"description":"配置模式。\n- 如果operator值为空,则表示使用全量覆盖模式进行配置,否则表示使用增删改模式进行配置。且此级列表的所有元素的operator值必须同时全为空或者非空。\n- 当使用增删改模式时,operator取值支持\"add\",\"copy\",\"modify\",\"delete\",分别表示新增,复制指定uid的元素修改后新增,修改指定uid的元素,删除指定uid的元素。\n- 当operator取值为\"copy\",\"modify\",\"delete\"时,uid的值必须为非空,且存在于最后一次生效的配置中。\n- 当operator取值为\"copy\",\"modify\"时,与operator同级别的字段中除uid外的所有字段如不写,置空或者为空列表,则表示保留在最后一次生效配置中指定uid的元素的同一字段的值。\n","type":"string"},"ports":{"description":"访问方式配置端口、协议、证书、URL路径等信息列表。","items":{"$ref":"#/definitions/AccessConfigurationPort"},"type":"array"},"private_ip":{"description":"响应体参数,用户选择的elb的私网ip。","type":"string"},"public_ip":{"description":"响应体参数,用户选择的elb的公网ip。","type":"string"},"type":{"description":"访问方式类型。","enum":["ClusterIP","LoadBalancer","Ingress"],"type":"string"},"uid":{"description":"访问方式的uid。","type":"string"}},"type":"object"},"AccessConfigurationHttpPath":{"description":"匹配路径和域名信息。","properties":{"hostname":{"description":"域名/不填,不填时表示使用IP。","type":"string"},"path":{"description":"URL路径。","type":"string"},"url_match_mode":{"description":"URL路径匹配模式,支持前缀匹配、正则匹配、精准匹配。","enum":["STARTS_WITH","REGEX","EQUAL_TO"],"type":"string"}},"type":"object"},"AccessConfigurationMetadata":{"description":"访问方式配置元数据。","properties":{"annotations":{"additionalProperties":{"type":"string"},"description":"附加参数。\n\n举例:负载均衡分配策略使用加权轮询算法,不启用健康检查。配置如下:\n- \"kubernetes.io/elb.health-check-flag\": \"off\"\n- \"kubernetes.io/elb.lb-algorithm\": \"ROUND_ROBIN\"\n","type":"object"}},"type":"object"},"AccessConfigurationPort":{"description":"访问方式配置端口、协议、证书等信息。","properties":{"certificate":{"description":"证书。","type":"string"},"default_certificate":{"description":"默认证书,访问方式配置为转发策略且协议为HTTPS时配置,未配置域名证书对时使用默认证书。","type":"string"},"elb_id":{"description":"用户选择的elb的ID。","type":"string"},"operator":{"description":"配置模式。\n- 如果operator值为空,则表示使用全量覆盖模式进行配置,否则表示使用增删改模式进行配置。且此级列表的所有元素的operator值必须同时全为空或者非空。\n- 当使用增删改模式时,operator取值支持\"add\",\"copy\",\"modify\",\"delete\",分别表示新增,复制指定uid的元素修改后新增,修改指定uid的元素,删除指定uid的元素。\n- 当operator取值为\"copy\",\"modify\",\"delete\"时,uid的值必须为非空,且存在于最后一次生效的配置中。\n- 当operator取值为\"copy\",\"modify\"时,与operator同级别的字段中除uid外的所有字段如不写,置空或者为空列表,则表示保留在最后一次生效配置中指定uid的元素的同一字段的值。\n","type":"string"},"paths":{"items":{"$ref":"#/definitions/AccessConfigurationHttpPath"},"type":"array"},"policy":{"description":"安全策略。","enum":["tls-1-2-strict","tls-1-2","tls-1-1","tls-1-0"],"type":"string"},"port":{"description":"访问端口。","type":"integer"},"protocol":{"description":"协议,负载均衡支持TCP,负载均衡与路由配置支持HTTP、HTTPS。","enum":["TCP","HTTP","HTTPS"],"type":"string"},"target_port":{"description":"监听端口。","type":"integer"},"uid":{"description":"端口配置的uid。","type":"string"}},"type":"object"},"AccessControl":{"description":"访问控制配置,允许配置黑名单、白名单。","properties":{"black":{"description":"黑名单数组。\n- 每行一个IP地址或网段,以回车结束。\n- 每个IP地址组最多可添加300个IP地址或网段。\n","items":{"type":"string"},"type":"array"},"white":{"description":"白名单数组。\n- 每行一个IP地址或网段,以回车结束。\n- 每个IP地址组最多可添加300个IP地址或网段。\n","items":{"type":"string"},"type":"array"}},"type":"object"},"ApiVersionObj":{"description":"API版本,固定值“v1”,该值不可修改。","enum":["v1"],"type":"string"},"Archive":{"description":"构建产物纳管。","properties":{"artifact_namespace":{"description":"产物纳管SWR组织。","type":"string"}},"type":"object"},"Build":{"description":"构建信息。","properties":{"archive":{"$ref":"#/definitions/Archive"},"parameters":{"$ref":"#/definitions/Parameters"}},"required":["archive","parameters"],"type":"object"},"CloudStorageLogPathInfo":{"description":"云存储日志扫描路径信息。","properties":{"dir_path":{"description":"容器挂载路径。","type":"string"},"file_name_pattern":{"description":"日志文件名匹配模式。","type":"string"}},"type":"object"},"ComponentKindObj":{"description":"API类型,固定值“Component”,该值不可修改。","enum":["Component"],"type":"string"},"ConfigurationData":{"description":"组件配置数据。","properties":{"metadata":{"$ref":"#/definitions/ConfigurationDataMetadata"},"spec":{"$ref":"#/definitions/ConfigurationRequestDataSpec"}},"type":"object"},"ConfigurationDataMetadata":{"description":"组件配置元数据。","properties":{"annotations":{"additionalProperties":{"type":"string"},"description":"附加参数。\n\n举例:负载均衡分配策略使用加权轮询算法,不启用健康检查。配置如下:\n- \"kubernetes.io/elb.health-check-flag\": \"off\"\n- \"kubernetes.io/elb.lb-algorithm\": \"ROUND_ROBIN\"\n","type":"object"}},"type":"object"},"ConfigurationItem":{"properties":{"data":{"$ref":"#/definitions/ConfigurationData"},"type":{"description":"组件配置类型。","enum":["rds","cse","env","access","scaling","volume","healthCheck","lifecycle","apm2","log","customMetric"],"type":"string"}},"required":["type","data"],"type":"object"},"ConfigurationRequestDataSpec":{"description":"组件配置数据规格详情。","properties":{"advanced":{"$ref":"#/definitions/ScaleConfigurationDataAdvanced","description":"伸缩策略高级配置。\n\nConfigurationItem.type为\"scaling\"时,配置此参数。\n","type":"object"},"cloud_storage_log_paths":{"description":"自定义云存储日志路径数组。\n\nConfigurationItem.type为\"log\"时,配置此参数。\n","items":{"$ref":"#/definitions/CloudStorageLogPathInfo"},"type":"array","x-api-inputuntrust-envparam":"Env"},"config_center_addr":{"description":"CSE配置中心地址。\n\nConfigurationItem.type为\"cse\"时,配置此参数。\n","type":"string","x-sec-sensitiveinfo":"Y"},"cse_id":{"description":"CSE引擎ID。\n\nConfigurationItem.type为\"cse\"时,配置此参数。\n","type":"string","x-sec-authority-parameter":"Y"},"envs":{"$ref":"#/definitions/EnvConfigurationDataAnnotations","description":"环境变量配置。\n\nConfigurationItem.type为\"env\"时,配置此参数。\n\n常用环境变量如下:\n- TZ: 时区设置,东八区可设置为Asia/Shanghai。\n- LANG: 语言字符集设置,中文UTF8可设置为zh_CN.UTF-8。\n","x-api-inputuntrust-envparam":"Env"},"instrumentation":{"description":"探针注入方式。\n\nConfigurationItem.type为\"apm2\"时,配置此参数。\n","type":"string"},"ip":{"description":"弹性公网IP,响应体参数,未配置域名时返回此参数。","type":"string"},"items":{"description":"访问方式配置列表。\n\nConfigurationItem.type为\"access\"时,配置此参数。\n","items":{"$ref":"#/definitions/AccessConfigurationDataItems"},"type":"array"},"livenessProbe":{"$ref":"#/definitions/HealthCheckConfigurationLivenessProbe","description":"组件健康检查配置的存活探针配置。\n\nConfigurationItem.type为\"healthCheck\"时,配置此参数。\n"},"log_paths":{"description":"自定义本地磁盘日志路径数组。\n\nConfigurationItem.type为\"log\"时,配置此参数。\n","items":{"type":"string"},"type":"array","x-api-inputuntrust-envparam":"Env"},"max_replica_count":{"description":"伸缩策略配置最大伸缩个数。\n\nConfigurationItem.type为\"scaling\"时,配置此参数。\n","type":"integer"},"metrics":{"description":"自定义监控指标配置指标名称。\n\nConfigurationItem.type为\"customMetric\"时,配置此参数。\n","items":{"type":"string"},"type":"array"},"min_replica_count":{"description":"伸缩策略配置最小伸缩个数。\n\nConfigurationItem.type为\"scaling\"时,配置此参数。\n","type":"integer"},"path":{"description":"自定义监控指标配置采集路径。\n\nConfigurationItem.type为\"customMetric\"时,配置此参数。\n","type":"string","x-api-inputuntrust-envparam":"Env"},"port":{"description":"自定义监控指标配置采集端口。\n\nConfigurationItem.type为\"customMetric\"时,配置此参数。\n","type":"integer"},"postStart":{"description":"生命周期管理组件配置启动后处理。\n\nConfigurationItem.type为\"lifecycle\"时,配置此参数。\n","properties":{"exec":{"$ref":"#/definitions/LifeCycleConfigurationExec"}},"type":"object"},"preStop":{"description":"生命周期管理组件配置停止前处理。\n\nConfigurationItem.type为\"lifecycle\"时,配置此参数。\n","properties":{"exec":{"$ref":"#/definitions/LifeCycleConfigurationExec"}},"type":"object"},"rds_address":{"description":"RDS数据库地址。\n\nConfigurationItem.type为\"rds\"时,配置此参数。\n","type":"string","x-sec-sensitiveinfo":"Y"},"rds_db_name":{"description":"RDS数据库名称。\n\nConfigurationItem.type为\"rds\"时,配置此参数。\n","type":"string"},"rds_id":{"description":"RDS数据库实例ID。\n\nConfigurationItem.type为\"rds\"时,配置此参数。\n","type":"string"},"rds_password":{"description":"RDS数据库密码。\n\nConfigurationItem.type为\"rds\"时,配置此参数。\n","type":"string","x-sec-sensitiveinfo":"Y"},"rds_port":{"description":"RDS数据库端口。\n\nConfigurationItem.type为\"rds\"时,配置此参数。\n","type":"string"},"rds_username":{"description":"RDS数据库用户名称。\n\nConfigurationItem.type为\"rds\"时,配置此参数。\n","type":"string"},"readinessProbe":{"$ref":"#/definitions/HealthCheckConfigurationReadinessProbe","description":"组件健康检查配置的就绪探针配置。\n\nConfigurationItem.type为\"healthCheck\"时,配置此参数。\n"},"scale_strategy":{"description":"伸缩策略配置策略类型。\n\nConfigurationItem.type为\"scaling\"时,配置此参数。\n","enum":["metric","time","mix"],"type":"string"},"service_center_addr":{"description":"CSE服务注册发现地址。\n\nConfigurationItem.type为\"cse\"时,配置此参数。\n","type":"string","x-sec-sensitiveinfo":"Y"},"startupProbe":{"$ref":"#/definitions/HealthCheckConfigurationStartupProbe","description":"组件健康检查配置的启动探针配置。\n\nConfigurationItem.type为\"healthCheck\"时,配置此参数。\n"},"triggers":{"description":"伸缩策略配置触发器列表。\n\nConfigurationItem.type为\"scaling\"时,配置此参数。\n","items":{"$ref":"#/definitions/ScaleConfigurationDataTrigger"},"type":"array"},"volumes":{"description":"云存储配置列表。\n\nConfigurationItem.type为\"volume\"时,配置此参数。\n","items":{"$ref":"#/definitions/VolumeConfigurationDataVolume"},"type":"array"}},"type":"object"},"CreateComponentSpec":{"description":"组件规格。","properties":{"available_replica":{"description":"可用实例个数。","format":"int32","type":"integer"},"build":{"$ref":"#/definitions/Build"},"env_id":{"description":"环境ID。","type":"string"},"replica":{"description":"实例个数。","format":"int32","type":"integer"},"resource_limit":{"$ref":"#/definitions/ResourceLimit"},"runtime":{"description":"语言/运行时。","enum":["Docker","Java8","Java11","Java17","Java21","Tomcat8","Tomcat9","Python3","Nodejs8","Nodejs14","Nodejs16","Php7","Php8","Dotnet6","Dotnet7","Dotnet8"],"type":"string"},"source":{"$ref":"#/definitions/Source"},"status":{"description":"组件状态。","type":"string"}},"type":"object"},"CreateComponentWithConfigurationRequestBody":{"example":{"api_version":"v1","configurations":[{"data":{"spec":{"rds_address":"100.xx.xx.xxx","rds_db_name":"cae","rds_id":"a5fdee4cf88c4277a68688a014f444bdin01","rds_password":"xxx","rds_port":"3306","rds_username":"cae"}},"type":"rds"}],"kind":"Component","metadata":{"annotations":{"version":"1.0.0"},"name":"demo-src"},"spec":{"build":{"archive":{"artifact_namespace":"xxx"},"parameters":{"base_image":"openjdk:8u181-jdk-alpine"}},"replica":2,"resource_limit":{"cpu_limit":"500m","memory_limit":"1Gi"},"runtime":"Java8","source":{"code":{"auth_name":"gitlab-xxx","branch":"master","namespace":"em1n"},"sub_type":"GitLab","type":"code","url":"https://xxx:8090/xxx/cae-frontend.git"}}},"properties":{"api_version":{"$ref":"#/definitions/ApiVersionObj"},"configurations":{"description":"配置项列表。","items":{"$ref":"#/definitions/ConfigurationItem"},"type":"array"},"kind":{"$ref":"#/definitions/ComponentKindObj"},"metadata":{"description":"请求数据。","properties":{"annotations":{"additionalProperties":{"type":"string"},"description":"创建组件请求体附加参数,当前只支持version参数,此参数必填。","example":{"version":"1.0.0"},"type":"object","x-api-inputuntrust-envparam":"Env"},"name":{"description":"组件名称。","type":"string","x-api-inputuntrust-envparam":"Env"}},"required":["name","annotations"],"type":"object"},"spec":{"description":"组件规格信息。","properties":{"build":{"$ref":"#/definitions/Build"},"image_url":{"description":"镜像地址。","type":"string","x-api-inputuntrust-envparam":"Env"},"replica":{"description":"实例个数。","type":"integer"},"resource_limit":{"$ref":"#/definitions/ResourceLimit"},"runtime":{"description":"语言/运行时。","enum":["Docker","Java8","Java11","Java17","Java21","Tomcat8","Tomcat9","Python3","Nodejs8","Nodejs14","Nodejs16","Php7","Php8","Dotnet6","Dotnet7","Dotnet8"],"type":"string"},"source":{"$ref":"#/definitions/Source"}},"required":["runtime","replica","resource_limit","source"],"type":"object"}},"required":["api_version","kind"],"type":"object"},"CreateComponentWithConfigurationResponseBody":{"example":{"api_version":"v1","configurations":[{"data":{"spec":{"rds_address":"100.xx.xx.xxx","rds_db_name":"cae","rds_id":"a5fdee4cf88c4277a68688a014f444bdin01","rds_password":"xxx","rds_port":"3306","rds_username":"cae"}},"type":"rds"}],"kind":"Component","metadata":{"annotations":{"version":"1.0.0"},"id":"xxxx","name":"demo-src"},"spec":{"build":{"archive":{"artifact_namespace":"xxx"},"parameters":{"base_image":"openjdk:8u181-jdk-alpine"}},"replica":2,"resource_limit":{"cpu_limit":"500m","memory_limit":"1Gi"},"runtime":"Java8","source":{"code":{"auth_name":"gitlab-xxx","branch":"master","namespace":"em1n"},"sub_type":"GitLab","type":"code","url":"https://xxx:8090/xxx/cae-frontend.git"}},"status":{"job_id":"xxx"}},"properties":{"api_version":{"$ref":"#/definitions/ApiVersionObj"},"configurations":{"description":"配置项列表。","items":{"$ref":"#/definitions/ConfigurationItem"},"type":"array"},"kind":{"$ref":"#/definitions/ComponentKindObj"},"metadata":{"$ref":"#/definitions/MetadataResponse"},"spec":{"$ref":"#/definitions/CreateComponentSpec"},"status":{"properties":{"job_id":{"description":"任务ID。","type":"string"}},"type":"object"}},"type":"object"},"CronTriggerScheduler":{"properties":{"cron":{"description":"触发时间点,以五位cron表达式表示。","type":"string"},"target_replica":{"description":"要求达到的实例数。","type":"integer"}},"type":"object"},"EnvConfigurationDataAnnotations":{"additionalProperties":{"type":"string"},"description":"环境变量配置。\n常用环境变量如下:\n- TZ: 时区设置,东八区可设置为Asia/Shanghai。\n- LANG: 语言字符集设置,中文UTF8可设置为zh_CN.UTF-8。","type":"object"},"HealthCheckConfigurationExec":{"description":"健康检查配置中执行命令检查。","properties":{"command":{"description":"shell语句。","items":{"type":"string"},"type":"array"}},"type":"object"},"HealthCheckConfigurationHttpGet":{"description":"健康检查配置中HTTP请求检查信息。","properties":{"path":{"description":"URL路径。","type":"string"},"port":{"description":"端口。","type":"integer"},"scheme":{"description":"协议。","enum":["HTTP","HTTPS"],"type":"string"}},"type":"object"},"HealthCheckConfigurationLivenessProbe":{"description":"组件健康检查配置的存活探针配置。","properties":{"exec":{"$ref":"#/definitions/HealthCheckConfigurationExec"},"failureThreshold":{"description":"最大失败次数。","type":"integer"},"httpGet":{"$ref":"#/definitions/HealthCheckConfigurationHttpGet"},"initialDelaySeconds":{"description":"延迟时间,单位为s。","type":"integer"},"periodSeconds":{"description":"检测周期,单位为s。","type":"integer"},"successThreshold":{"description":"成功阈值。","type":"integer"},"tcpSocket":{"$ref":"#/definitions/HealthCheckConfigurationTcpSocket"},"timeoutSeconds":{"description":"超时时间,单位为s。","type":"integer"}},"type":"object"},"HealthCheckConfigurationReadinessProbe":{"description":"组件健康检查配置的就绪探针配置。","properties":{"exec":{"$ref":"#/definitions/HealthCheckConfigurationExec"},"failureThreshold":{"description":"最大失败次数。","type":"integer"},"httpGet":{"$ref":"#/definitions/HealthCheckConfigurationHttpGet"},"initialDelaySeconds":{"description":"延迟时间,单位为s。","type":"integer"},"periodSeconds":{"description":"检测周期,单位为s。","type":"integer"},"successThreshold":{"description":"成功阈值。","type":"integer"},"tcpSocket":{"$ref":"#/definitions/HealthCheckConfigurationTcpSocket"},"timeoutSeconds":{"description":"超时时间,单位为s。","type":"integer"}},"type":"object"},"HealthCheckConfigurationStartupProbe":{"description":"组件健康检查配置的启动探针配置。","properties":{"exec":{"$ref":"#/definitions/HealthCheckConfigurationExec"},"failureThreshold":{"description":"最大失败次数。","type":"integer"},"httpGet":{"$ref":"#/definitions/HealthCheckConfigurationHttpGet"},"initialDelaySeconds":{"description":"延迟时间,单位为s。","type":"integer"},"periodSeconds":{"description":"检测周期,单位为s。","type":"integer"},"successThreshold":{"description":"成功阈值。","type":"integer"},"tcpSocket":{"$ref":"#/definitions/HealthCheckConfigurationTcpSocket"},"timeoutSeconds":{"description":"超时时间,单位为s。","type":"integer"}},"type":"object"},"HealthCheckConfigurationTcpSocket":{"description":"健康检查配置中TCP端口检查信息。","properties":{"port":{"description":"端口。","type":"integer"}},"type":"object"},"LifeCycleConfigurationExec":{"description":"执行命令。","properties":{"command":{"description":"shell语句。","items":{"type":"string"},"type":"array"}},"type":"object"},"MetadataResponse":{"description":"响应数据。","properties":{"annotations":{"additionalProperties":{"type":"string"},"description":"组件附加属性。\n- log_group_id:LTS日志组的ID。\n- log_stream_id:LTS日志流的ID。\n- version:组件版本。","type":"object"},"created_at":{"description":"创建时间。","format":"date-time","type":"string"},"id":{"description":"组件ID。","type":"string"},"name":{"description":"组件名称。","type":"string"},"updated_at":{"description":"更新时间。","format":"date-time","type":"string"}},"type":"object"},"Parameters":{"additionalProperties":{"type":"string"},"description":"构建附加参数。\n- base_image:基础镜像地址。\n- build_cmd:自定义构建命令。\n- dockerfile_path:自定义dockerfile文件路径\n- dockerfile_content:自定义dockerfile内容\n- artifact_name: 针对java多模块构建,指定构建后运行的产物,以\".jar\"结尾。","example":{"base_image":"openjdk:8u181-jdk-alpine","build_cmd":"mvn clean package"},"type":"object"},"Repo":{"description":"源码仓库信息。","properties":{"auth_name":{"description":"授权名称。","type":"string"},"branch":{"description":"分支。","type":"string"},"namespace":{"description":"命名空间,需填写命名空间的Base64编码。","type":"string"}},"type":"object"},"ResourceLimit":{"description":"实例规格。","properties":{"cpu_limit":{"description":"cpu限额。","enum":["500m","1000m","2000m"],"type":"string"},"memory_limit":{"description":"内存限额。","enum":["1Gi","2Gi","4Gi"],"type":"string"}},"required":["cpu_limit","memory_limit"],"type":"object"},"ScaleConfigurationDataAdvanced":{"description":"伸缩策略高级配置。","properties":{"disable_scaledown":{"description":"是否禁用自动缩容。","type":"boolean"},"scaledown_rate":{"description":"缩容步长。","type":"integer"},"scaledown_stabilization_seconds":{"description":"缩容冷却时间窗。","type":"integer"},"scaleup_rate":{"description":"扩容步长。","type":"integer"},"scaleup_stabilization_seconds":{"description":"扩容冷却时间窗。","type":"integer"}},"type":"object"},"ScaleConfigurationDataTrigger":{"description":"伸缩策略触发器。","properties":{"metadata":{"$ref":"#/definitions/ScalingTriggerMeta"},"type":{"description":"指标类型。","enum":["cpu","memory","cron"],"type":"string"}},"type":"object"},"ScalingTriggerMeta":{"description":"trigger元数据。","properties":{"period_type":{"description":"生效周期。\n\nScaleConfigurationDataTrigger.type为\"cron\"时,配置此参数。\n","enum":["day","week","month"],"type":"string"},"schedulers":{"description":"每个周期内触发的时间点和实例数。\n\nScaleConfigurationDataTrigger.type为\"cron\"时,配置此参数。\n","items":{"$ref":"#/definitions/CronTriggerScheduler"},"type":"array"},"type":{"description":"数据类型,当前只支持利用率,默认值为Utilization。\n\nScaleConfigurationDataTrigger.type为\"cpu、memory\"时,配置此参数。\n","type":"string"},"value":{"description":"触发指标的阈值。\n\nScaleConfigurationDataTrigger.type为\"cpu、memory\"时,配置此参数。\n","type":"string"}},"type":"object"},"Source":{"description":"源信息。","properties":{"code":{"$ref":"#/definitions/Repo"},"sub_type":{"description":"源子类型。\n- 源类型为code时,子类型表示不同的代码仓库,如DevCloud(CodeArts)、GitLab、GitHub、Gitee、Bitbucket。\n- 源类型为softwarePackage时,子类型表示不同的软件包仓库,如BinObs、BinDevCloud(CodeArts软件发布库)。","enum":["BinObs","BinDevCloud","GitLab","GitHub","DevCloud","Gitee","Bitbucket"],"type":"string"},"type":{"description":"源类型。","enum":["image","code","softwarePackage"],"type":"string"},"url":{"description":"url地址。\n- 源类型为image时,url地址为镜像地址。\n- 源类型为code时,url地址为git地址。\n- 源类型为softwarePackage时,url地址为软件包地址。","type":"string"}},"required":["type","url"],"type":"object"},"VolumeConfigurationDataVolume":{"description":"云存储配置数据。","properties":{"mount_info":{"items":{"$ref":"#/definitions/VolumeConfigurationMountInfo"},"type":"array"},"resource_name":{"description":"云存储名称。","type":"string"},"resource_sub_type":{"description":"云存储子类型。","enum":["object_bucket","parallel_file_system","sfs3.0"],"type":"string"},"resource_type":{"description":"云存储类型。","enum":["obs","sfs"],"type":"string"},"umask":{"description":"设置目录或文件缺省权限,默认值0027,sfs3.0类型的云存储不支持配置此参数。","type":"string"},"volume_id":{"description":"云存储ID。","type":"string","x-sec-authority-parameter":"Y"}},"type":"object"},"VolumeConfigurationMountInfo":{"description":"云存储配置挂载信息。","properties":{"access_mode":{"description":"读写权限。","enum":["ReadWriteMany","ReadOnlyMany"],"type":"string"},"path":{"description":"容器挂载路径。","type":"string"},"sub_path":{"description":"子路径。","type":"string"}},"type":"object"}},"description":null,"group_id":"233de030b8054c65a90cfefe2e0b09aa","host":"cae.cn-north-4.myhuaweicloud.com","id":"c7b4e59680f14f7ab1efab81475a1f21","info_version":"v1","method":"post","name":"CreateComponentWithConfiguration","parameters":{"param_header_x_auth_token":{"description":"用户Token。 \n- 获取Token,请参考《[统一身份认证服务API参考](https://support.huaweicloud.com/api-iam/iam_30_0001.html)》的“获取用户Token”章节。 \n- 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。","in":"header","maxLength":16384,"name":"X-Auth-Token","required":true,"type":"string","x-order":52},"param_header_x_enterprise_project_id":{"description":"企业项目ID。 \n- 创建环境时,环境会绑定企业项目ID。 \n- 最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。 \n- 该字段不传(或传为字符串“0”)时,则查询默认企业项目下的资源。\n\n> 关于企业项目ID的获取及企业项目特性的详细信息,请参见《[企业管理服务用户指南](https://support.huaweicloud.com/usermanual-em/zh-cn_topic_0126101490.html)》。","in":"header","name":"X-Enterprise-Project-ID","pattern":"^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$|^0$","required":false,"type":"string","x-order":53},"param_header_x_environment_id":{"description":"环境ID。 \n- 获取环境ID,通过《[云应用引擎API参考](https://support.huaweicloud.com/api-cae/ListEnvironments.html)》的“获取环境列表”章节获取环境信息。 \n- 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息,其中id字段即是环境ID。","in":"header","name":"X-Environment-ID","pattern":"^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$","required":true,"type":"string","x-order":54},"param_path_project_id":{"description":"项目ID,获取项目ID请参见[获取项目ID](https://support.huaweicloud.com/api-cae/cae_06_0021.html)。","in":"path","name":"project_id","required":true,"type":"string","x-order":1,"x-sec-authority-parameter":"Y"}},"paths":{"/v1/{project_id}/cae/applications/{application_id}/component-with-configurations":{"post":{"consumes":["application/json"],"description":"创建、生效配置并部署组件。","operationId":"CreateComponentWithConfiguration","parameters":[{"$ref":"#/parameters/param_path_project_id"},{"description":"应用ID。","in":"path","name":"application_id","required":true,"type":"string","x-sec-authority-parameter":"Y"},{"$ref":"#/parameters/param_header_x_auth_token"},{"$ref":"#/parameters/param_header_x_enterprise_project_id"},{"$ref":"#/parameters/param_header_x_environment_id"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CreateComponentWithConfigurationRequestBody"}}],"produces":["application/json"],"responses":{"200":{"description":"请求成功。","examples":{"application/json":"{\n \"api_version\": \"v1\",\n \"kind\": \"Component\",\n \"metadata\": {\n \"id\": \"cac09548-047f-46c4-abbd-a6a652305565\",\n \"name\": \"test-code\",\n \"annotations\": {\n \"log_group_id\": \"5b13213a-84f8-4b72-8ca5-530e15cc1402\",\n \"log_stream_id\": \"6ddf6c71-4767-46db-98a2-fe5fb301b366\",\n \"version\": \"1.0.0\"\n },\n \"created_at\": \"2023-02-13T02:38:22.689607114Z\",\n \"updated_at\": \"2023-02-13T02:38:22.689607114Z\"\n },\n \"spec\": {\n \"runtime\": \"Java8\",\n \"env_id\": \"9819b3f5-dd08-44ff-ba88-eb38e435594c\",\n \"replica\": 1,\n \"source\": {\n \"type\": \"code\",\n \"sub_type\": \"GitLab\",\n \"url\": \"http://xxx@cpe.gitlab.com:8090/xxx/cae-backend.git\",\n \"code\": {\n \"branch\": \"master\",\n \"auth_name\": \"gitlab-xxx\",\n \"namespace\": \"em1n\"\n }\n },\n \"build\": {\n \"archive\": {\n \"artifact_namespace\": \"xxx\"\n },\n \"parameters\": {\n \"base_image\": \"openjdk:8u181-jdk-alpine\"\n \"dockerfile_path\": \"./Dockerfile\"\n }\n },\n \"resource_limit\": {\n \"cpu_limit\": \"500m\",\n \"memory_limit\": \"1Gi\"\n },\n \"available_replica\": 0,\n \"status\": \"created\"\n },\n \"configurations\": [\n {\n \"type\": \"volume\",\n \"data\": {\n \"spec\": {\n \"volumes\": [\n {\n \"volume_id\": \"84f2e74c-c684-4933-bcf6-b6c230386049\",\n \"resource_name\": \"test-cae\",\n \"resource_type\": \"obs\",\n \"resource_sub_type\": \"object_bucket\",\n \"umask\": \"0027\",\n \"mount_info\": [\n {\n \"path\": \"/tmp/test\",\n \"sub_path\": \"\",\n \"access_mode\": \"ReadWriteMany\",\n \"create_time\": \"2024-06-07T03:06:46.094Z\"\n }\n ]\n }\n ]\n }\n },\n \"operation_id\": \"c2120961-df90-4a77-8195-357ad21505b2\",\n \"operated_at\": \"2024-06-11T07:44:22.856241Z\",\n \"is_activated\": false\n },\n {\n \"type\": \"access\",\n \"data\": {\n \"metadata\": {\n \"annotations\": {\n \"deployBackend\": \"k8s\"\n },\n \"created_at\": \"0001-01-01T00:00:00Z\",\n \"updated_at\": \"0001-01-01T00:00:00Z\"\n },\n \"spec\": {\n \"ip\": \"\",\n \"elb_private_ip\": \"\",\n \"items\": [\n {\n \"uid\": \"4ad7dba0-50d4-420a-9a91-be2de4eb41df\",\n \"type\": \"LoadBalancer\",\n \"metadata\": {\n \"annotations\": {\n \"kubernetes.io/elb.health-check-flag\": \"on\",\n \"kubernetes.io/elb.health-check-option\": \"{\\\"protocol\\\":\\\"TCP\\\",\\\"delay\\\":\\\"5\\\",\\\"timeout\\\":\\\"10\\\",\\\"max_retries\\\":\\\"3\\\"}\"\n },\n \"created_at\": \"0001-01-01T00:00:00Z\",\n \"updated_at\": \"0001-01-01T00:00:00Z\"\n },\n \"elb_id\": \"defaultElbID\",\n \"access_control\": null,\n \"public_ip\": \"100.93.14.168\",\n \"private_ip\": \"\",\n \"ports\": [\n {\n \"ip\": \"\",\n \"name\": \"\",\n \"target_port\": 80,\n \"port\": 80,\n \"protocol\": \"TCP\",\n \"default_certificate\": \"\"\n }\n ],\n \"default_certificate\": \"\"\n }\n ]\n },\n \"ref\": {\n \"id\": \"ac24d721-f1e0-47da-ab9c-bad1d3b874ea\"\n }\n },\n \"operation_id\": \"c2120961-df90-4a77-8195-357ad21505b2\",\n \"operated_at\": \"2024-06-11T07:44:21.969021Z\",\n \"is_activated\": false\n }\n ],\n status:{\n \"job_id\":\"xxx\"\n }\n}"},"schema":{"$ref":"#/definitions/CreateComponentWithConfigurationResponseBody"}}},"summary":"创建、生效配置并部署组件","tags":["Component"],"x-api-framework":"RestfulAPI","x-api-position":"Region_ZONE","x-api-type":"open-api","x-api-user":"IAM_User","x-api-userinput-untrust":{"EnvParam":"name,annotations,image_url"},"x-apiexplorer-hide":"false","x-authority-parameter-url":"project_id, application_id","x-is-registered":"Y","x-open-region-cloud":"hws,hws_eu,hws_hk","x-request-examples-1":{"api_version":"v1","configurations":[{"data":{"spec":{"items":[{"elb_id":"defaultElbID","ports":[{"port":80,"protocol":"TCP","target_port":80}],"type":"LoadBalancer"}]}},"type":"access"}],"kind":"Component","metadata":{"annotations":{"version":"1.0.0"},"name":"test-code"},"spec":{"build":{"archive":{"artifact_namespace":"xxx"},"parameters":{"base_image":"openjdk:8u181-jdk-alpine","dockerfile_path":"./Dockerfile"}},"replica":1,"resource_limit":{"cpu_limit":"500m","memory_limit":"1Gi"},"runtime":"Java8","source":{"code":{"auth_name":"gitlab-xxx","branch":"master","namespace":"em1n"},"sub_type":"GitLab","type":"code","url":"https://xxx:8090/xxx/cae-frontend.git"}}},"x-request-examples-2":{"api_version":"v1","configurations":[{"data":{"spec":{"items":[{"elb_id":"defaultElbID","ports":[{"port":80,"protocol":"TCP","target_port":80}],"type":"LoadBalancer"}]}},"type":"access"}],"kind":"Component","metadata":{"annotations":{"version":"1.0.0"},"name":"test-image"},"spec":{"replica":1,"resource_limit":{"cpu_limit":"500m","memory_limit":"1Gi"},"runtime":"Docker","source":{"type":"image","url":"nginx:stable-alpine-perl"}}},"x-request-examples-3":{"api_version":"v1","configurations":[{"data":{"spec":{"items":[{"elb_id":"defaultElbID","ports":[{"port":80,"protocol":"TCP","target_port":80}],"type":"LoadBalancer"}]}},"type":"access"}],"kind":"Component","metadata":{"annotations":{"version":"1.0.0"},"name":"test-jar"},"spec":{"build":{"archive":{"artifact_namespace":"xxx"},"parameters":{"base_image":"openjdk:8u181-jdk-alpine","dockerfile_content":"FROM java:8 \\nADD forecast-1.0.0.jar \\nEXPOSE 8080 \\nENTRYPOINT [\"java\",\"-jar\",\"forecast-1.0.0.jar\"]"}},"replica":1,"resource_limit":{"cpu_limit":"500m","memory_limit":"1Gi"},"runtime":"Java8","source":{"sub_type":"BinObs","type":"softwarePackage","url":"https://xxx.obs.region.xxx.huawei.com/xxx/forecast-1.0.0.jar"}}},"x-request-examples-description-1":"使用源码仓库创建组件,组件名称“test-code”,版本“1.0.0”,选择GitLab源码仓库,运行时为Java8,并配置访问方式负载均衡。","x-request-examples-description-2":"使用镜像创建组件,组件名称“test-image”,版本“1.0.0”,选择nginx镜像,运行时为Docker,并配置访问方式负载均衡。","x-request-examples-description-3":"使用软件包创建组件,组件名称“test-jar”,版本“1.0.0”,在OBS对象存储中选择名称为“forecast-1.0.0.jar”的软件包,运行时为Java8,并配置访问方式负载均衡。","x-request-examples-url-1":"POST https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/component-with-configurations","x-request-examples-url-2":"POST https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/component-with-configurations","x-request-examples-url-3":"POST https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/component-with-configurations","x-sec-auditlog":"Y","x-sec-privacy-datalevel":"L3","x-sec-upload-download":"N","x-support-sdk":"Y"}}},"product_short":"CAE","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"创建、生效配置并部署组件","tags":"组件","uri":null,"version":"2.0"}