文档首页> 应用管理与运维平台 ServiceStage> API参考（吉隆坡区域）> 应用管理API> 实例> 修改应用组件实例
更新时间：2023-06-26 GMT+08:00
查看PDF

修改应用组件实例

功能介绍

通过此API修改应用组件实例。

URI

PUT /v2/{project_id}/cas/applications/{application_id}/components/{component_id}/instances/{instance_id}

表1 路径参数

参数

参数类型

必选

描述

project_id

String

是

租户项目ID

application_id

String

是

应用ID

component_id

String

是

组件ID

instance_id

String

是

组件实例ID

请求消息

表2 请求参数

参数

参数类型

必选

描述

version

String

是

应用组件版本号，满足版本语义，如1.0.1。

flavor_id

String

否

资源规格，可查询获取所有支持的应用资源规格接口获取系统预定义好的资源规格。

如果需要自定义资源规格的话，自定义资源规格的格式为：CUSTOM-xxG:xxC-xxC:xxGi-xxGi。其中：

  • xxG表示给组件实例分配的存储的大小，为保留字段，当前未生效，可以指定为一个固定的数字。
  • xxC-xxC用于指定给组件实例分配的cpu最大核数和最小核数。
  • xxGi-xxGi用于指定给组件实例分配的最大内存和最小内存。

例如，CUSTOM-10G:0.5C-0.25C:1.6Gi-0.8Gi，表示给组件实例分配的cpu核数最大为0.5核，最小为0.25核，分配的最大内存为1.6Gi，最小为0.8Gi。

artifacts

Map<String, Object>

否

组件部署件。key为组件名，对于Docker多容器场景，key为容器名称,请参考表3。

configuration

Map<String, Object>

否

配置参数，如设置环境变量，部署配置, 运维监控等， 默认空。请参考创建组件实例的表3。

description

String

否

描述。

最大长度为128个字符。

external_accesses

Array of objects

否

访问方式，请参考表4。

refer_resources

Array of objects

否

部署资源，请参考表5。
表3 artifact参数

参数

参数类型

必选

描述

storage

String

是

存储方式，支持swr和obs。

type

String

是

类别，虚机部署为package，容器部署为image。

url

String

是

软件包/镜像地址。对于基于虚机部署的组件，值为软件包的地址。对于基于容器部署的组件，值为镜像的地址或者“组件名:v${index}”，后者表示使用组件来源中的源码或者软件包自动构建生成的镜像。

auth

String

是

认证方式，支持iam和none，默认为iam。

version

String

否

版本号。

properties

Map<String,String>

否

属性。
表4 external_accesses参数

参数

参数类型

必选

描述

protocol

String

否

协议，支持http和https

address

String

否

访问地址，如www.example.com

forward_port

Integer

否

应用组件进程监听端口
表5 refer_resources参数

参数

参数类型

必选

描述

id

String

是

资源ID。

type

String

是

资源类型，含dcs等类型。

refer_alias

String

否

应用别名，dcs时才提供，支持“distributed_session”、“distributed_cache”、“distributed_session, distributed_cache”，默认值是“distributed_session, distributed_cache”。

parameters

Map<String,Object>

否

引用资源参数。

响应消息

表6 响应参数说明

参数

参数类型

描述

job_id

String

Job ID，用于查询创建任务信息。

示例

请求示例

{
	"description": "",
	"artifacts": {
		"test-micro": {
			"storage": "swr",
			"type": "image",
			"url": "swr.roma-dev-1.roma.development.com/ns1/examples:v2",
			"auth": "iam",
			"version": "1.0.0",
			"properties": {}
		}
	},
	"refer_resources": [
		{
			"id": "523498f1-36c4-11eb-ae36-0255ac1000c2",
			"type": "cce",
			"parameters": {
				"namespace": "default"
			}
		},
		{
			"id": "default",
			"type": "cse"
		}
	],
	"version": "1.0.2"
}

响应示例

{
    "job_id": "JOB66761060-f209-407c-a093-4df6f531b9dc"
}

状态码

表7 状态码说明

状态码

描述

200

操作成功。

400

错误的请求。

404

请求对象不存在

500

内部错误

错误码

错误码格式为：SVCSTG.00100.[Error_ID]，例如：SVCSTG.00100400。错误码说明请参考应用管理API错误码。

父主题： 实例