Modifying a Component Instance

project_id

Yes

String

Tenant's project ID. See Obtaining a Project ID.

application_id

Yes

String

Application ID. See Obtaining All Applications.

component_id

Yes

String

Component ID. See Obtaining All Components of an Application.

instance_id

Yes

String

Component instance ID. See Obtaining All Component Instances.

Content-Type

Yes

String

Message body type (format). Default value: application/json;charset=utf8.

X-Auth-Token

Yes

String

API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token. For details about how to obtain a token, see Obtaining a User Token.

version

Yes

String

Application component version that meets version semantics. Example: 1.0.1.

flavor_id

No

String

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 CUSTOM-xxG:xxm-xxm:xxGi-xxGi. Where:

• xxG: storage capacity allocated to a component instance. It is a reserved field. You can set it to a fixed number.
• xxm-xxm: 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.5m-0.25m: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

No

Map<String, Object>

Artifact. key indicates the component name. In the Docker container scenario, key indicates the container name. See Table 4.

configuration

No

Object

Configuration parameters, such as environment variables, deployment configurations, and O&M monitoring. By default, this parameter is left blank. See Table 4 in Creating an Application Component Instance.

description

No

String

Description.

The value can contain up to 128 characters.

external_accesses

No

Array of objects

Access mode. See Table 5.

refer_resources

No

Array of objects

Deployed resources. See Table 6.

storage

Yes

String

Storage mode. Value: swr (software repository), swr (image), obs, or codearts.

type

Yes

String

Type.

• VM-based deployment supports package.
• Container-based deployment supports package and image.

url

Yes

String

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

Yes

String

Authentication mode. Value: iam or none. Default value: iam.

version

No

String

Version number.

properties

No

Map<String,String>

Property information.

id

No

String

Access type ID.

protocol

Yes

String

Protocol. Value: http or https.

address

Yes

String

Access address. Example: www.example.com.

forward_port

Yes

Integer

Port for listening to an application component process.

type

No

String

Type.

status

No

String

Status.

create_time

No

Integer

Creation time.

update_time

No

Integer

Update time.

id

Yes

String

Resource ID.

type

Yes

String

Resource type. Example: rds or dcs.

refer_alias

No

String

Application alias. This parameter is available only when type is set to dcs. Value: "distributed_session", "distributed_cache", or "distributed_session, distributed_cache" (default).

parameters

No

Map<String, Object>

Reference resource parameter.

job_id

String

Job ID, which is used to query information about the created job.

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error