文档首页> 应用管理与运维平台 ServiceStage> API参考> 应用示例> 组件管理

更新时间：2023-07-31 GMT+08:00

查看PDF

组件管理

场景描述

本章节指导用户通过API实现组件管理。API的调用方法请参见如何调用API。

流程介绍

在某个应用下创建组件
创建组件实例
查询创建组件实例任务状态
升级组件实例
获取组件实例快照
回滚组件实例
对组件实例进行其他生命周期的操作，如停止，启动，重启等

前提条件

获取IAM的token，调用Token认证，并将token值设置为环境变量：export Token={token}。
获取ServiceStage的endpoint，请参考地区和终端节点，以下示例中以{servicestage_endpoint}代替。

操作步骤

在某个应用下创建组件。调用应用中创建组件接口。请求示例如下：

curl -k -H "Content-Type:application/json" -H "X-Auth-Token:$token" -X POST "https://{servicestage_endpoint}/v3/{project_id}/cas/applications/{application_id}/components" -d ' 
{
    "name": "test-component",
    "description": "",
    "labels": [],
    "version": "2023.0712.09204",
    "environment_id": "21a43958-f64f-4077-8ae3-3a03bf0111c7",
    "application_id": "2c458700-c8e0-4651-a73b-5219b70a6572",
    "enterprise_project_id": "0",
    "runtime_stack": {
        "name": "Docker",
        "version": "",
        "type": "Docker",
        "deploy_mode": "container"
    },
    "source": {
        "kind": "image",
        "storage": "swr",
        "url": "swr.cn-north-7.myhuaweicloud.com/servicestage-demo/test_02:v1",
        "version": "v1"
    },
    "tomcat_opts": {
        "server_xml": ""
    },
    "refer_resources": [
        {
            "id": "1d3091a2-1ecf-11ee-ae69-0255ac1001ba",
            "type": "cce",
            "parameters": {
                "namespace": "default",
                "type": "VirtualMachine"
            }
        }
    ],
    "replica": 2,
    "config_mode": "ui",
    "limit_cpu": 0.25,
    "limit_memory": 0.5,
    "request_cpu": 0.25,
    "request_memory": 0.5,
    "external_accesses": [],
    "storages": [],
    "logs": [],
    "affinity": {
        "az": [],
        "node": [],
        "component": []
    },
    "anti_affinity": {
        "az": [],
        "node": [],
        "component": []
    },
    "update_strategy": {
        "type": "RollingUpdate",
        "max_surge": 0,
        "max_unavailable": 1
    },
    "command": {
        "args": [],
        "command": []
    },
    "custom_metric": {}
}'

返回结果：

{
    "job_id": "JOB870e9ffe-227e-43a9-9c84-20a7ad02e77c",
    "component_id": "f3f6cb89-831d-4579-8bbc-664487889e38"
}

得到的job_id，后续示例中以{job_id}代替，得到的component_id，后续示例中以{component_id}代替。

查询创建组件任务状态。调用获取部署任务详细信息接口，去查询任务状态是否成功。请求示例如下。

curl -k -H "Content-Type:application/json" -H "X-Auth-Token:$Token" -X GET "https://{servicestage_endpoint}/v2/{project_id}/cas/jobs/{job_id}"

返回结果：

{
    "job": {
        "JOB_ID": "JOB870e9ffe-227e-43a9-9c84-20a7ad02e77c", 
        "JOB_NAME": "provision/provMain", 
        "JOB_TYPE": "PROVISION", 
        "SERVICE_INSTANCE_ID": "429a35a0-dee8-4648-86f6-d1f8bc74ba52", 
        "PROJECT_ID": "063a3158b1a34710b36ad208b9497d00", 
        "ORDER_ID": "", 
        "JOB_DESC": "provision/provMain", 
        "EXECUTION_STATUS": "SUCCEEDED", 
        "CREATED_BY": "585cc5c16cda4954b28d4eb460f06261"
    }, 
    "tasks": [
        {
            "MESSAGES": "{}", 
            "TASK_ID": "Task-bc64b46c-1688-4787-b7ff-87cb53b346ea", 
            "TASK_TYPE": "echo", 
            "TASK_INDEX": 1, 
            "TASK_NAME": "SEPARATOR_PREPARE_RESOURCES", 
            "TASK_STATUS": "SUCCEEDED", 
            "LAST_HEALTH_CHECK": "2020-02-04T04:01:03.344Z", 
            "CREATED_AT": "2020-02-04T04:01:03.344Z", 
            "OWNER_ID": "cas-mgr-69bb87d7c-wpqwb:30114"
        }, 
        {
            "MESSAGES": "{}", 
            "TASK_ID": "Task-15ec252f-bca0-401e-ae5b-798a639df92e", 
            "TASK_TYPE": "echo", 
            "TASK_INDEX": 4, 
            "TASK_NAME": "SEPARATOR_BUILDING", 
            "TASK_STATUS": "SUCCEEDED", 
            "LAST_HEALTH_CHECK": "2020-02-04T04:01:03.346Z", 
            "CREATED_AT": "2020-02-04T04:01:03.345Z", 
            "OWNER_ID": "cas-mgr-69bb87d7c-wpqwb:30114"
        }, 
        {
            "MESSAGES": "{}", 
            "TASK_ID": "Task-52a5d1ae-2c54-46ec-8134-53e7b6a45fb7", 
            "TASK_TYPE": "restful", 
            "TASK_INDEX": 6, 
            "TASK_NAME": "TN00091", 
            "TASK_STATUS": "SUCCEEDED", 
            "LAST_HEALTH_CHECK": "2020-02-04T04:01:08.924Z", 
            "CREATED_AT": "2020-02-04T04:01:03.346Z", 
            "OWNER_ID": "cas-mgr-69bb87d7c-wpqwb:30114"
        }, 
        {
            "MESSAGES": "{}", 
            "TASK_ID": "Task-a149b585-d31b-4c72-a665-d820efcb0bf9", 
            "TASK_TYPE": "restful", 
            "TASK_INDEX": 7, 
            "TASK_NAME": "TN00094", 
            "TASK_STATUS": "SUCCEEDED", 
            "LAST_HEALTH_CHECK": "2020-02-04T04:01:08.961Z", 
            "CREATED_AT": "2020-02-04T04:01:08.925Z", 
            "OWNER_ID": "cas-mgr-69bb87d7c-wpqwb:30114"
        }, 
        {
            "MESSAGES": "", 
            "TASK_ID": "Task-a72fe8d8-8cc1-42b5-a097-0cf9e29692a7", 
            "TASK_TYPE": "restful", 
            "TASK_INDEX": 9, 
            "TASK_NAME": "TN00097", 
            "TASK_STATUS": "SUCCEEDED", 
            "LAST_HEALTH_CHECK": "2020-02-04T04:01:38.975Z", 
            "CREATED_AT": "2020-02-04T04:01:08.962Z", 
            "OWNER_ID": "cas-mgr-69bb87d7c-wpqwb:30114"
        }
    ], 
    "task_count": 5
}

升级组件。调用根据组件ID修改组件信息接口，调用完之后，还是需要调用2的接口，用返回的job_id查询任务状态，等待升级完成。请求示例如下：

curl -k -H "Content-Type:application/json" -H "X-Auth-Token:$token" -X PUT "https://{servicestage_endpoint}/v3/{project_id}/cas/applications/{application_id}/components/{component_id}" -d ' 
{
    "source": {
        "kind": "image",
        "storage": "swr",
        "url": "swr.cn-north-7.myhuaweicloud.com/lwx554185/arm_tomcat8:v1"
    },
    "version": "2023.0717.17160",
    "refer_resources": [
        {
            "id": "1d3091a2-1ecf-11ee-ae69-0255ac1001ba",
            "type": "cce",
            "parameters": {
                "namespace": "default",
                "type": "ARM64"
            }
        }
    ],
    "limit_cpu": 0.25,
    "limit_memory": 0.5,
    "request_cpu": 0.25,
    "request_memory": 0.5,
    "mesher": {},
    "affinity": {},
    "anti_affinity": {},
    "liveness_probe": {},
    "readiness_probe": {},
    "command": {
        "command": [],
        "args": []
    },
    "envs": [
        {
            "name": "PAAS_PROJECT_ID",
            "inner": false,
            "value": "063a3158b1a34710b36ad208b9497d00"
        },
        {
            "name": "CAS_APP_ID",
            "inner": false,
            "value": "f3f6cb89-831d-4579-8bbc-664487889e38"
        },
        {
            "name": "PAAS_CLUSTER_ID",
            "inner": false,
            "value": "1d3091a2-1ecf-11ee-ae69-0255ac1001ba"
        },
        {
            "name": "CAS_APPLICATION_ID",
            "inner": false,
            "value": "2c458700-c8e0-4651-a73b-5219b70a6572"
        },
        {
            "name": "CAS_INSTANCE_VERSION",
            "inner": false,
            "value": "2023.0717.17062"
        },
        {
            "name": "CAS_COMPONENT_ID",
            "inner": false,
            "value": "e1c3021b-df40-48e9-bd41-ef033fc77f2b"
        },
        {
            "name": "CAS_INSTANCE_NAME",
            "inner": false,
            "value": "etst1-test-arm-5xdhrd"
        },
        {
            "name": "CAS_COMPONENT_NAME",
            "inner": false,
            "value": "etst1"
        },
        {
            "name": "PAAS_NAMESPACE",
            "inner": false,
            "value": "default"
        },
        {
            "name": "PAAS_APP_NAME",
            "inner": false,
            "value": "etst1"
        },
        {
            "name": "PAAS_PROJECT_NAME",
            "inner": false,
            "value": "cn-north-7"
        },
        {
            "name": "CAS_INSTANCE_ID",
            "inner": false,
            "value": "f3f6cb89-831d-4579-8bbc-664487889e38"
        },
        {
            "name": "CAS_ENVIRONMENT_NAME",
            "inner": false,
            "value": "test_arm"
        },
        {
            "name": "AOM_DISCOVERY_RULE_VERSION",
            "inner": false,
            "value": "V1"
        },
        {
            "name": "CAS_ENVIRONMENT_ID",
            "inner": false,
            "value": "21a43958-f64f-4077-8ae3-3a03bf0111c7"
        },
        {
            "name": "testName",
            "inner": false,
            "value": "testValue"
        },
        {
            "name": "PAAS_REGION_NAME",
            "inner": false,
            "value": "cn-north-7"
        },
        {
            "name": "CAS_APPLICATION_NAME",
            "inner": false,
            "value": "app-test-application"
        }
    ],
    "deploy_strategy": {
        "type": "RollingRelease",
        "rolling_release": {
            "batches": "1"
        }
    },
    "id": "f3f6cb89-831d-4579-8bbc-664487889e38",
    "name": "etst1"
}'

返回结果：

{
    "job_id": "JOB2209202b-617c-4591-b0c6-ef2521a943a2"
}

回滚组件。调用根据组件ID下发组件任务接口，将组件回滚到上个版本。调用完之后，还是需要调用2的接口，用返回的job_id查询任务状态，等待任务完成。请求示例如下：

curl -k -H "Content-Type:application/json" -H "X-Auth-Token:$token" -X POST "https://{servicestage_endpoint}/v3/{project_id}/cas/applications/{application_id}/components/{component_id}/action" -d ' 
{
    "action": "rollback_current"
}'

返回结果：

{
    "job_id": "JOB66eb56db-062e-4462-ba95-8d3c63d5d462"
}

对组件进行其他生命周期的操作，如停止，启动，重启等。调用根据组件ID下发组件任务接口。调用完之后，还是需要调用2的接口，用返回的job_id查询任务状态，等待任务完成。这里以停止组件实例为例子，请求示例如下：
```
curl -k -H "Content-Type:application/json" -H "X-Auth-Token:$token" -X POST "https://{servicestage_endpoint}/v3/{project_id}/cas/applications/{application_id}/components/{component_id}/action" -d ' 
{
    "action": "stop"
}'
```
返回结果：
```
{
    "job_id": "JOB2790bf9f-7d6e-473d-827f-1bb94e0cf10d"
}
```

父主题： 应用示例

上一篇：应用管理

下一篇：注册发现

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

组件管理

场景描述

流程介绍

前提条件

操作步骤

相关文档

相关产品

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线