Updated on 2025-10-22 GMT+08:00

Creating a Pro Instance

Function

This API is used to create ROMA Connect RCU instances.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

POST /v3/{project_id}/roma/instances

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant to which the instance belongs.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Name.

description

No

String

Instance description.

charge_type

Yes

String

Billing mode of the instance. The value can be: - prePaid: yearly/monthly. - postPaid: pay-per-use billing.

available_zone_ids

Yes

Array of strings

AZ list.

cpu_arch

Yes

String

Architecture type.

enterprise_project_id

No

String

The enterprise project ID must be used together with the enterprise project switch. This parameter is mandatory when the enterprise project is enabled.

rcu

Yes

rcu object

RCU configuration of the RCU instance.

vpc_id

Yes

String

VPC ID selected by the user.

subnet_id

Yes

String

Subnet selected by the user.

ingress_bandwidth_size

No

Integer

Inbound public network bandwidth, which takes effect when public access is enabled.

publicip_enable

No

Boolean

Public network access. The default value is false.

config

No

config object

Parameter for creating an instance association resource.

scope

No

String

IES edge instance. The value is edge. The default value is center.

Table 3 rcu

Parameter

Mandatory

Type

Description

total

No

Integer

Sum of RCUs.

distribution

No

Array of RCUAssignReq objects

RCU allocation.

Table 4 RCUAssignReq

Parameter

Mandatory

Type

Description

indicator

Yes

indicator object

RCU metric object.

value

Yes

Integer

Number of RCUs assigned to the target. The value must be within the specified range.

Table 5 indicator

Parameter

Mandatory

Type

Description

id

Yes

String

RCU metric ID.

Table 6 config

Parameter

Mandatory

Type

Description

mqs

No

mqs object

MQS parameter of the instance. By default, the parameter does not need to be configured.

Table 7 mqs

Parameter

Mandatory

Type

Description

engine_version

No

String

Engine version.

retention_policy

No

String

Policy for processing messages after the MQS disk capacity reaches the threshold. Options:

  • produce_reject: New messages cannot be created.

  • time_base: The earliest messages are deleted.

ssl_enable

No

Boolean

Whether to enable SSL. Options:

  • true: enable

  • false: disable

trace_enable

No

Boolean

Whether to enable message tracing. Options:

  • true: enable

  • false: disable

vpc_client_plain

No

Boolean

Whether to enable VPC plaintext access. Options:

  • true: enable

  • false: disable

Response Parameters

Status code: 202

Table 8 Response body parameters

Parameter

Type

Description

instance_id

String

Instance ID.

job_id

String

Instance task ID.

Status code: default

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

202

ok

default

response for errors

Error Codes

See Error Codes.