Help Center/ ROMA Connect/ User Guide(new)/ Connectors/ Huawei Cloud Services/ CodeArts IDE Online
Updated on 2024-11-25 GMT+08:00
View PDF
Share

CodeArts IDE Online

The CodeArts IDE Online connector interconnects with Huawei Cloud CodeArts IDE Online.

CodeArts IDE Online is a cloud development environment service that enables you to quickly obtain and access the environment using a browser to complete coding, building, debugging, running, code preview, repo access, and command execution, along with a broad range of extensions.

Prerequisites

You have subscribed to CodeArts IDE Online.

Creating a CodeArts IDE Online Connection

  1. Log in to the new ROMA Connect console.
  2. In the navigation pane on the left, choose Connector. On the page displayed, click New Connection.
  3. Select the CodeArts IDE Online connector.
  4. In the dialog box displayed, configure the connector and click OK.

Parameter

Description

Name

Enter the connector instance name.

Description

Enter the description of the connector to identify it.

Access Key

Access key ID (AK) of the current account. Obtain the AK by referring to Access Keys. If an AK/SK pair has been generated, find the downloaded AK/SK file (such as credentials.csv).

Secret Access Key

Secret access key (SK) of the current account. Obtain the SK by referring to Access Keys. If an AK/SK pair has been generated, find the downloaded AK/SK file (such as credentials.csv).

Action

  • Listing IDE instances
  • Creating an IDE instance
  • Listing IDE instances of a tenant
  • Stopping an IDE instance
  • Starting an IDE instance
  • Deleting an IDE instance
  • Modifying an IDE instance
  • Querying an IDE instance
  • Checking whether the IDE instance name is duplicate

Configuring Parameters

Table 1 Listing IDE instances

Parameter

Description

region_id

Region ID.

limit

Number of records displayed on each page. Value range: 1–100

offset

Offset where the query starts.

is_temporary

Whether to display on the page (depending on the tag configuration).

label

Tag.

search

Query by keyword (fuzzy query by instance name and description).

sort_dir

Sorting mode. Value options: asc and desc.

sort_key

Sorting field. Value options: display_name (instance name), status, pvc_quantity (storage capacity), created_time, and stack_id.
Table 2 Creating an IDE instance

Parameter

Description

org_id

Tenant ID (corresponding to domainId of the Huawei Cloud account).

region_id

Region ID.

agent_id

Dealer ID, which is used in the tutorial activity scenario.

arch

CPU architecture. Value options: x86 and Arm.

cpu_memory

CPU specifications (Arm: 4 vCPUs and 8 GB memory; x86: 1 vCPU and 1 GB memory, 2 vCPUs and 4 GB memory, and 2 vCPUs and 8 GB memory), which correspond to the specifications configured for the stack and can be obtained by calling the ListStacks API. If the tag is not empty, refer to the stack specifications configured for the tag. Quantum stack: 2 vCPUs and 8 GB memory (x86). Other stacks: 1 vCPU and 1 GB memory or 2 vCPUs and 4 GB memory (x86).

description

Description.

display_name

Instance name, which can contain digits, letters, underscores (_), periods (.), and hyphens (-). Value length: 3–100 characters

is_temporary

Instance tag. Third-party systems need to set the tag together with CodeArts IDE Online. If this parameter is not transferred, the default value is used.

label_tag

Sorting mode. Value options: asc and desc.

plugin_enable_list

Pre-set plug-ins.

plugin_vars

Pre-set plug-in parameters. Encrypt sensitive information if needed.

port_id

(Optional) Port ID of the cloud server, required when the ECS is accessed via the private network.

private_ip

(Optional) IP address of the cloud server, required when the ECS is accessed via the private network.

pvc_quantity

PVC specifications, for example, 5 GB, 10 GB, 20 GB.

refresh_interval

Auto hibernation time. Arm: 30 or 60. x86: 30, 60, 240, 1440, or –1. The unit of values except –1 (no hibernation) is minute. If no operation is performed on an instance for a period longer than the specified duration, the instance will be suspended (all saved data will not be deleted).

repository_id

(Optional) JointForce repository ID, required in the JointForce scenario.

stack_id

Stack ID, obtained via the ListStacks API.

task_type

Task type, which is used in the tutorial activity scenario.

token

(Optional) JointForce token, required in the JointForce scenario.

vpc_id

(Optional) VPC ID of the cloud server, required when the ECS is accessed via the private network.

instance_domain_id

Tenant ID of the authorized user of the instance.

instance_user_id

ID of the authorized user of the instance.
Table 3 Listing IDE instances of a tenant

Parameter

Description

org_id

Tenant ID (corresponding to domainId of the Huawei Cloud account).

region_id

Region ID.

is_temporary

Instance tag. Third-party systems need to set the tag together with CodeArts IDE Online. If this parameter is not transferred, the default value is used.

limit

Number of records displayed on each page. Value options: 10, 15, and 30.

offset

Offset where the query starts.

search

Query by keyword (fuzzy query by instance name and description).
Table 4 Stopping an IDE instance

Parameter

Description

instance_id

Instance ID.

region_id

Region ID.
Table 5 Starting an IDE instance

Parameter

Description

instance_id

Instance ID.

region_id

Region ID.

plugin_enable_list

Plug-ins.

plugin_vars

Plug-in parameters. Encrypt sensitive information if needed.
Table 6 Deleting an IDE instance

Parameter

Description

instance_id

Instance ID.

region_id

Region ID.
Table 7 Modifying an IDE instance

Parameter

Description

instance_id

Instance ID.

region_id

Region ID.

description

Description.

display_name

Instance name, which can contain digits, letters, underscores (_), periods (.), and hyphens (-). Value length: 3–100 characters

refresh_interval

Auto hibernation time. Arm: 30 or 60. x86: 30, 60, 240, 1440, or –1. The unit of all values except –1 (no hibernation) is minute. If no operation is performed on an instance for a period longer than the specified duration, the instance will be suspended (all saved data will not be deleted).
Table 8 Querying an IDE instance

Parameter

Description

instance_id

Instance ID.

region_id

Region ID.
Table 9 Checking whether the IDE instance name is duplicate

Parameter

Description

region_id

Region ID.

display_name

Instance name, which can contain digits, letters, underscores (_), dots (.), and dashes (-). Value length: 3–100 characters
Parent topic: Huawei Cloud Services