Help Center/ ServiceStage/ API Reference (ME-Abu Dhabi Region)/ Application Management APIs/ Instance/ Creating an Application Component Instance

Updated on 2023-06-25 GMT+08:00

View PDF

Creating an Application Component Instance

Function

This API is used to create an application component instance.

URI

POST /v2/{project_id}/cas/applications/{application_id}/components/{component_id}/instances

**Table 1** Path parameters
Parameter	Type	Mandatory	Description
project_id	String	Yes	Tenant's project ID.
application_id	String	Yes	Application ID.
component_id	String	Yes	Component ID.

Request

**Table 2** Request parameters
Parameter	Type	Mandatory	Description
name	String	Yes	Component instance name. The value contains 2 to 63 characters consisting of lowercase letters, digits, and hyphens (-). It starts with a lowercase letter and ends with a lowercase letter or digit.
environment_id	String	Yes	Environment ID.
replica	Integer	Yes	Number of instance replicas.
flavor_id	String	Yes	Resource specifications, which can be obtained by using the API in Obtaining All Supported Flavors of Application Resources. If you need to customize resource specifications, the format is as follows: CUSTOM-xxG:xxC-xxC:xxGi-xxGi. Where: xxG: storage capacity allocated to a component instance. It is a reserved field. You can set it to a fixed number. xxC-xxC: the maximum and minimum number of CPU cores allocated to a component instance. xxGi-xxGi: the maximum and minimum memory allocated to a component instance. For example, CUSTOM-10G:0.5C-0.25C:1.6Gi-0.8Gi indicates that the maximum number of CPU cores allocated to a component instance is 0.5, the minimum number of CPU cores is 0.25, the maximum memory is 1.6 Gi, and the minimum memory is 0.8 Gi.
artifacts	Map<String, Object>	Yes	Artifact. key indicates the component name. In the Docker container scenario, key indicates the container name. See Table 19.
version	String	Yes	Application component version that meets version semantics. Example: 1.0.0.
configuration	Object	No	Configuration parameters, such as environment variables, deployment configurations, and O&M monitoring. By default, this parameter is left blank. See Table 3.
description	String	No	Description. The value can contain up to 128 characters.
external_accesses	Array of objects	No	External network access. See Table 20.
refer_resources	Array of objects	Yes	Deployed resources. See Table 21.

**Table 3** configuration parameters
Parameter	Type	Mandatory	Description
env	Array of objects	No	Environment variable. See Table 4.
storage	Array of objects	No	Data storage configuration. For details, see Table 5.
strategy	Object	No	Upgrade policy. For details, see Table 6.
lifecycle	Object	No	Lifecycle. For details, see Table 7.
scheduler	Object	No	Scheduling policy. For details, see Table 8.
probes	Object	No	Health check. For details, see Table 9.

**Table 4** environment parameters
Parameter	Type	Mandatory	Description
name	String	Yes	Name of the environment variable. The value contains 1 to 64 characters consisting of letters, digits, underscores (_), hyphens (-), and dots (.), and cannot start with a digit.
value	String	Yes	Environment variable value.

**Table 5** storage parameters
Parameter	Type	Mandatory	Description
type	String	Yes	Storage type. Value: HostPath: host path mounting. EmptyDir: temporary directory mounting. ConfigMap: configuration item mounting. Secret: secret volume mounting. PersistentVolumeClaim: cloud storage mounting.
parameters	Object	Yes	Storage parameter. For details, see Table 18.
mounts	Array of objects	Yes	Directory mounted to the container. For details, see Table 17.

**Table 6** strategy parameter
Parameter	Type	Mandatory	Description
upgrade	String	No	Upgrade policy. Value: Recreate or RollingUpdate (default). The former indicates in-place upgrade while the latter indicates rolling upgrade.

**Table 7** lifecycle parameters
Parameter	Type	Mandatory	Description
entrypoint	Object	No	Startup command. For details, see Table 15.
post-start	Object	No	Post-start processing. For details, see Table 15.
pre-stop	Object	No	Pre-stop processing. For details, see Table 15.

**Table 8** scheduler parameters
Parameter	Type	Mandatory	Description
affinity	Object	No	Affinity. For details, see Table 14.
anti-affinity	Object	No	Anti-affinity. For details, see Table 14.

**Table 9** probes parameters
Parameter	Type	Mandatory	Description
livenessProbe	Object	No	Component liveness probe. For details, see Table 10.
readinessProbe	Object	No	Component service probe. For details, see Table 10.

**Table 10** probes_object parameters
Parameter	Type	Mandatory	Description
type	String	Yes	Value: http, tcp, or command. The check methods are HTTP request check, TCP port check, and command execution check, respectively.
parameters	Object	Yes	Parameters. If type is set to http, see Table 11. If type is set to tcp, see Table 13. If type is set to command, see Table 12.
delay	Integer	No	Interval between the startup and detection.
timeout	Integer	No	Detection timeout interval.

**Table 11** probes_param_http parameters
Parameter	Type	Mandatory	Description
scheme	String	Yes	Value: HTTP or HTTPS.
host	String	No	Pod IP address (default). You can specify an IP address.
port	Integer	Yes	Port.
path	String	Yes	Request path.

**Table 12** probes_param_command parameters
Parameter	Type	Mandatory	Description
command	Array of String	Yes	Command list.

**Table 13** probes_param_tcp parameters
Parameter	Type	Mandatory	Description
port	Integer	Yes	Port

**Table 14** scheduler_affinity parameters
Parameter	Type	Mandatory	Description
az	Array of String	No	AZ list.
node	Array of String	No	Node private IP address list.
application	Array of String	No	Component instance list.

**Table 15** lifecycle_entrypoint parameters
Parameter	Type	Mandatory	Description
command	Array of String	Yes	Command that can be executed.
args	Array of String	Yes	Running parameters.

**Table 16** lifecycle_process parameters
Parameter	Type	Mandatory	Description
type	String	Yes	Value: command or http. The former indicates command execution and the latter indicates HTTP requests.
parameters	Object	Yes	Post-start or pre-stop processing parameters. See Table 17.

**Table 17** lifecycle_process_parameters parameters
Parameter	Type	Mandatory	Description
command	Array of String	Yes	Command parameters, for example, ["sleep", "1"]. This parameter is applicable to the command type.
host	String	No	Pod IP address (default). You can also specify an IP address. This parameter is applicable to the http type.
port	Integer	Yes	Port number. This parameter is applicable to the http type.
path	String	Yes	Request URL. This parameter is applicable to the http type.

**Table 18** storage_parameters parameters
Parameter	Type	Mandatory	Description
path	String	No	Host path. This parameter is applicable to the HostPath storage type.
name	String	No	Name of a configuration item or secret. This parameter is applicable to the ConfigMap and Secret storage type.
claimName	String	No	PVC name. This parameter is applicable to the PersistentVolumeClaim storage type.

**Table 19** artifact parameters
Parameter	Type	Mandatory	Description
storage	String	Yes	Storage mode. Value: swr or obs.
type	String	Yes	Type. Value: package (VM-based deployment) or image (container-based deployment).
url	String	Yes	Software package or image address. For a component deployed on a VM, this parameter is the software package address. For a component deployed based on a container, this parameter is the image address or component name:v${index}. The latter indicates that the component source code or the image automatically built using the software package will be used.
auth	String	Yes	Authentication mode. Value: iam or none. Default value: iam.
version	String	No	Version number.
properties	Map<String, Object>	No	Property information.

**Table 20** external_accesses parameters
Parameter	Type	Mandatory	Description
protocol	String	No	Protocol. Value: http or https.
address	String	No	Access address.
forward_port	Integer	No	Port number.

**Table 21** refer_resources parameters
Parameter	Type	Mandatory	Description
id	String	Yes	Resource ID. Note: If type is set to ecs, the value of this parameter must be Default.
type	String	Yes	Basic resources: cce, and ecs. Optional resources: dcs, elb, and other services.
refer_alias	String	No	Application alias, which is provided only in DCS scenario. Value: "distributed_session", "distributed_cache", "distributed_session, distributed_cache". Default value: "distributed_session, distributed_cache".
parameters	Map<String,Object>	No	Reference resource parameter. NOTICE: When type is set to cce, this parameter is mandatory. You need to specify the namespace of the cluster where the component is to be deployed. Example: {"namespace": "default"}. When type is set to ecs, this parameter is mandatory. You need to specify the hosts where the component is to be deployed. Example: {"hosts":["04d9f887-9860-4029-91d1-7d3102903a69", "04d9f887-9860-4029-91d1-7d3102903a70"]}}.

Response

**Table 22** Response parameters
Parameter	Type	Description
job_id	String	Job ID, which is used to query information about the created job.
instance_id	String	Component instance ID.

Example

Example request

{
    "name": "component-instance-name", 
    "environment_id": "6e763000-9128-4a9d-adea-34c42cc5344d", 
    "flavor_id": "MICRO-5G:0.5C:1G", 
    "replica": 1, 
    "artifacts": {
        "container-name": {
            "storage": "swr", 
            "type": "image", 
            "url": "{IP}:20202/xxxxxxxx/junit-platformstest:1.0", 
            "auth": "iam"
        }
    }, 
    "version": 1, 
    "description": "instance desc", 
    "configuration": {
        "env": [
            {
                "name": "log-level", 
                "value": "warn"
            }
        ]
    }, 
    "refer_resources": [
        {
            "id": "b6862a62-d916-11e9-bdf1-0255ac101fd9", 
            "type": "cce", 
            "parameters": {
                "namespace": "default"
            }
        }, 
        {
            "id": "8c0a45cc-626f-4d65-8257-507ee059aa9a", 
            "type": "elb"
        }
    ]
}

Example response

{
    "instance_id": "89f5baf5-efe4-4f12-9c0d-734d2af5a184", 
    "job_id": "JOB66761060-f209-407c-a093-4df6f531b9dc"
}

Status Code

**Table 23** Status codes
Status Code	Description
200	OK
400	Bad Request
404	Not Found
500	Internal Server Error

Error Code

Error code must be in the format of SVCSTG.00100.[Error_ID]. Example: SVCSTG.00100400. See Error Codes of Application Management APIs.

Parent topic: Instance

Previous topic: Instance

Next topic: Obtaining All Instances of a Component

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot