# 应用中导入CCE工作负载创建组件 - ImportCCEWorkloadToAnApplicationToCreateComponent #### 功能介绍 在CCE中，工作负载（Workload）是指一组以某种方式协同工作的Pod集合，它们为了完成一个特定的应用程序或服务而存在。 此API用于在应用中导入CCE中已经创建的工作负载用于创建组件。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-servicestage/servicestage_06_0183.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | servicestage:app:createComponent | write | app \* | - [g:EnterpriseProjectId](https://support.huaweicloud.com/usermanual-iam5/iam_01_1287.html) - [g:RequestTag/\](https://support.huaweicloud.com/usermanual-iam5/iam_01_1287.html) | servicestage:app:create | - aom:discoveryRule:list - aom:discoveryRule:set - as:scalingConfig:create - as:scalingConfig:get - as:scalingConfig:list - as:scalingPolicy:create - as:scalingPolicy:get - as:scalingPolicy:list - cce:cluster:get - dcs:instance:get - dns:recordset:create - dns:recordset:get - ecs:cloudServers:get - elb:l7policies:create - elb:l7policies:get - elb:l7policies:list - elb:listeners:create - elb:listeners:get - elb:listeners:list - elb:members:create - elb:members:get - elb:members:list - ims:dataImages:create - ims:images:create - ims:images:get - ims:images:list - ims:wholeImages:create - rds:instance:get - servicestage:assembling:create - servicestage:assembling:getInfo - vpc:addressGroups:get - vpc:networks:get - vpc:routeTables:get - vpc:securityGroupRules:get - vpc:securityGroups:get - vpc:subnets:get - vpc:subnets:get - vpc:vpcs:get | #### URI POST /v3/{project_id}/cas/applications/{application_id}/components 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户项目ID。获取方法，请参考[获取项目ID](https://support.huaweicloud.com/api-servicestage/servicestage_06_0164.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | application_id | 是 | String | **参数解释：** 应用ID。获取方法，请参考[获取所有应用 - ObtainAllApplications](https://support.huaweicloud.com/api-servicestage/servicestage_06_0068.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 请求消息 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Content-Type | 是 | String | **参数解释：** 消息体的类型（格式）。 **约束限制：** 不涉及 **取值范围：** application/json;charset=utf8 **默认取值：** 不涉及 | | X-Auth-Token | 是 | String | **参数解释：** 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考[认证鉴权](https://support.huaweicloud.com/api-servicestage/servicestage_06_0010.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表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]。 | 表4labels | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 是 | String | **参数解释：** 标签名称。 **取值范围：** 1到36个字符，只能包含数字、英文字母、下划线（_）、中划线（-）或中文。 说明： Key的取值不能是系统内置的app、casid或version，否则会导致创建并部署组件时报错。 **默认取值：** 不涉及 | | value | 是 | String | **参数解释：** 标签值。 **取值范围：** 0到43个字符，只能包含数字、英文字母、下划线（_）、点（.）、中划线（-）或中文。 **默认取值：** 不涉及 | 表5refer_resources | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 是 | String | **参数解释：** 资源ID。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | type | 是 | String | **参数解释：** 资源类型。 **取值范围：** - elb：弹性负载均衡 - cce：云容器引擎 - dcs：分布式缓存服务 - rds：云数据库RDS - cse：ServiceComb引擎 - nacos：注册配置中心 - gaussdb：云数据库GaussDB - dms_rocketmq：分布式消息服务RocketMQ - pvc：存储卷声明 - css_es：云搜索服务Elasticsearch - custom_k8s：自定义kubernetes集群 **默认取值：** 不涉及 | | parameters | 否 | Object | **参数解释：** 资源参数，请参考[表6]。 | 表6refer_resource_parameter | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | namespace | 否 | String | **参数解释：** 命名空间。 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表7external_accesses | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | protocol | 否 | String | **参数解释：** 外部访问类型。 **取值范围：** - http：超文本传输协议 - https：超文本传输安全协议 **默认取值：** 不涉及 | | address | 否 | String | **参数解释：** 外部访问地址。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | forward_port | 否 | Integer | **参数解释：** 外部访问端口。 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 响应消息 表8响应参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | instance_id | String | **参数解释：** 组件实例ID。 **取值范围：** 不涉及 | | component_id | String | **参数解释：** 组件ID。 **取值范围：** 不涉及 | | job_id | String | **参数解释：** 任务ID。 **取值范围：** 不涉及 | #### 请求示例 通过从id为1d23eab7-da00-11ee-a1e1-0255ac1001ba的CCE中导入test-deployment工作负载，创建名为test-import-deployment的无状态组件。 ``` { "name": "test-import-deployment", "description": "", "version": "2024.0506.16306", "environment_id": "9cff7557-4ebb-481b-bc1e-6a6573b5b8d2", "workload_name": "test-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" } ``` #### 响应示例 ``` { "instance_id": "7897df44-e9c3-486f-9406-7a55e9aa55e2" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 操作成功 | | 400 | 错误的请求 | | 404 | 请求对象不存在 | | 500 | 内部错误 | #### 错误码 请参考[ServiceStage错误码](https://support.huaweicloud.com/api-servicestage/servicestage_06_0162.html)。