Modifying an API

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference.

instance_id

Yes

String

Instance ID.

api_id

Yes

String

API ID.

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

name

Yes

String

API name.

The value can contain only letters, digits, hyphens (-), underscores (_), periods (.), slashes (/), parentheses, and colons (:). The value must start with a letter or digit.

Minimum: 3

Maximum: 255

type

Yes

Integer

API type.

• 1: public

• 2: private

version

No

String

API version.

Maximum: 16

req_protocol

Yes

String

API request protocol.

• HTTP

• HTTPS

• BOTH: Both HTTP and HTTPS are supported.

Default: HTTPS

req_method

Yes

String

API request method.

req_uri

Yes

String

Request URI. The value can contain request parameters identified by braces ({}), for example, /getUserInfo/{userId}. Special characters such as * / / %- _ . are supported. The total length cannot exceed 512 characters and must meet the URI specifications.

auth_type

Yes

String

API authentication mode. The options are as follows:

• NONE

• APP

• IAM

• AUTHORIZER (custom)

auth_opt

No

AuthOpt object

Security authentication parameter.

cors

No

Boolean

Whether CORS is supported.

• TRUE: supported

• FALSE: not supported

Default: false

match_mode

No

String

Match mode of an API.

• SWA: prefix match

• NORMAL: exact match (default) The default value is NORMAL.

backend_type

Yes

String

Backend type.

• HTTP: web backend

• FUNCTION: FunctionGraph backend

• MOCK: Mock backend

remark

No

String

Description of the API, which cannot contain < and >.

Minimum: 0

Maximum: 1000

group_id

Yes

String

ID of the API group to which the API belongs.

Minimum: 1

Maximum: 65

body_remark

No

String

API request body, which can be an example request body, media type, or parameters.

Maximum: 20480

result_normal_sample

No

String

Example response for a successful request.

Maximum: 20480

result_failure_sample

No

String

Example response for a failed request.

Maximum: 20480

authorizer_id

No

String

ID of the frontend custom authorizer.

Minimum: 1

Maximum: 65

tags

No

Array of strings

Tags.

The value can contain only letters, digits, and underscores (_), and must start with a letter. You can enter multiple tags and separate them with commas (,).

Minimum: 1

Maximum: 128

response_id

No

String

Group response ID.

This parameter is currently not supported.

Minimum: 1

Maximum: 65

roma_app_id

No

String

ID of the integration application to which an API belongs.

This parameter is mandatory when the API group is a global group or when an API is bound to a user-defined domain name.

Minimum: 1

Maximum: 65

domain_name

No

String

User-defined domain name bound to the API. If a user-defined domain name is used, the roma_app_id field is mandatory.

Maximum: 255

tag

No

String

Tag.

This field will be deprecated. You can use the tags field instead.

Maximum: 255

mock_info

No

ApiMockCreate object

Mock backend details.

func_info

No

ApiFuncCreate object

FunctionGraph backend details.

req_params

No

Array of ReqParamBase objects

Request parameters.

backend_params

No

Array of BackendParamBase objects

Backend parameters.

policy_mocks

No

Array of ApiPolicyMockCreate objects

Mock policy backend information.

policy_functions

No

Array of ApiPolicyFunctionCreate objects

FunctionGraph policy backend information.

backend_api

No

BackendApiCreateV1 object

Web backend details

policy_https

No

Array of ApiPolicyHttpCreateV1 objects

Web policy backends.

app_code_auth_type

No

String

Indicates whether AppCode authentication is enabled. This parameter is valid only if auth_type is set to App. The default value is DISABLE.

• DISABLE: AppCode authentication is disabled.

• HEADER: AppCode authentication is enabled and the AppCode is located in the header.

Default: DISABLE

remark

No

String

Description.

Maximum: 255

result_content

No

String

Response.

version

No

String

Version. Ensure that the version does not exceed 64 characters.

authorizer_id

No

String

Backend custom authorizer ID.

status_code

No

Integer

Customized status code of the mock backend: "200": "OK", "201": "Created", "202": "Accepted", "203": "NonAuthoritativeInformation", "204": "NoContent", "205": "ResetContent", "206": "PartialContent", "300": "MultipleChoices", "301": "MovedPermanently", "302": "Found", "303": "SeeOther", "304": "NotModified", "305": "UseProxy", "306": "Unused", "307": "TemporaryRedirect", "400": "BadRequest", "401": "Unauthorized", "402": "PaymentRequired", "403": "Forbidden", "404": "NotFound", "405": "MethodNotAllowed", "406": "NotAcceptable", "407": "ProxyAuthenticationRequired", "408": "RequestTimeout", "409": "Conflict", "410": "Gone", "411": "LengthRequired", "412": "PreconditionFailed", "413": "RequestEntityTooLarge", "414": "RequestURITooLong", "415": "UnsupportedMediaType", "416": "RequestedRangeNotSatisfiable", "417": "ExpectationFailed", "450": "ParameterRequried", "451": "MethodConnectException", "500": "InternalServerError", "501": "NotImplemented", "502": "BadGateway", "503": "ServiceUnavailable", "504": "GatewayTimeout", "505": "HTTPVersionNotSupported"

header

No

String

Custom response header of the mock backend.

Format: [{"key":"","value": "", "remark:""}, {"key2":"","value2": "","remark2:""}]

Description:

key: key of the mock backend's custom response header. It must start with a letter or digit, and can include only letters, digits, and hyphens (-) (max. 64 characters).

value: value of the mock backend's custom response header. This parameter cannot be empty (max. 10,240 characters).

remark: remark of the mock backend's custom response header. This parameter can be empty (max. 2048 characters).

function_urn

Yes

String

Function URN.

network_type

No

String

Network architecture type of the function. Options:

• V1: non-VPC

• V2: VPC

Default: V1

remark

No

String

Description.

Maximum: 255

invocation_type

Yes

String

Invocation mode.

• async: asynchronous

• sync: synchronous

version

No

String

Version of a function.

If both the alias URN and version are specified, the version is ignored and only the alias URN is used.

Maximum: 64

alias_urn

No

String

Alias URN of a function.

If both the alias URN and version are specified, the version is ignored and only the alias URN is used.

timeout

Yes

Integer

Timeout allowed for APIC to request the backend service. You can set the maximum timeout using the backend_timeout configuration item. The maximum value is 600,000.

Unit: ms

Minimum: 1

authorizer_id

No

String

Backend custom authorizer ID.

name

Yes

String

Parameter name. The value can contain letters, digits, hyphens (-), underscores (_), and periods (.) and must start with a letter.

Minimum: 1

Maximum: 32

type

Yes

String

Parameter type.

location

Yes

String

Parameter location.

default_value

No

String

Default value.

sample_value

No

String

Example value.

required

No

Integer

Indicates whether the parameter is mandatory.

• 1: The parameter is mandatory.

• 2: The parameter is optional.

The value of this parameter is 1 if Location is set to PATH, and 2 if Location is set to another value.

valid_enable

No

Integer

Indicates whether validity check is enabled.

• 1: enabled

• 2: disabled

Default: 2

remark

No

String

Description.

Maximum: 255

enumerations

No

String

Enumerated value.

min_num

No

Integer

Minimum value.

This parameter is valid when type is set to NUMBER.

max_num

No

Integer

Maximum value.

This parameter is valid when type is set to NUMBER.

min_size

No

Integer

Minimum length.

This parameter is valid when type is set to STRING.

max_size

No

Integer

Maximum length.

This parameter is valid when type is set to STRING.

regular

No

String

Regular expression validation rule.

This parameter is currently not supported.

json_schema

No

String

JSON validation rule.

This parameter is currently not supported.

pass_through

No

Integer

Indicates whether to transparently transmit the parameter.

• 1: The parameter is transparently transmitted.

• 2: The parameter is not transparently transmitted.

result_content

No

String

Response.

status_code

No

Integer

Customized status code of the mock backend: "200": "OK", "201": "Created", "202": "Accepted", "203": "NonAuthoritativeInformation", "204": "NoContent", "205": "ResetContent", "206": "PartialContent", "300": "MultipleChoices", "301": "MovedPermanently", "302": "Found", "303": "SeeOther", "304": "NotModified", "305": "UseProxy", "306": "Unused", "307": "TemporaryRedirect", "400": "BadRequest", "401": "Unauthorized", "402": "PaymentRequired", "403": "Forbidden", "404": "NotFound", "405": "MethodNotAllowed", "406": "NotAcceptable", "407": "ProxyAuthenticationRequired", "408": "RequestTimeout", "409": "Conflict", "410": "Gone", "411": "LengthRequired", "412": "PreconditionFailed", "413": "RequestEntityTooLarge", "414": "RequestURITooLong", "415": "UnsupportedMediaType", "416": "RequestedRangeNotSatisfiable", "417": "ExpectationFailed", "450": "ParameterRequried", "451": "MethodConnectException", "500": "InternalServerError", "501": "NotImplemented", "502": "BadGateway", "503": "ServiceUnavailable", "504": "GatewayTimeout", "505": "HTTPVersionNotSupported"

header

No

String

Custom response header of the mock backend.

Format: [{"key":"","value": "", "remark:""}, {"key2":"","value2": "","remark2:""}]

Description:

key: key of the mock backend's custom response header. It must start with a letter or digit, and can include only letters, digits, and hyphens (-) (max. 64 characters).

value: value of the mock backend's custom response header. This parameter cannot be empty (max. 10,240 characters).

remark: remark of the mock backend's custom response header. This parameter can be empty (max. 2048 characters).

effect_mode

Yes

String

Effective mode of the backend policy.

• ALL: All conditions are met.

• ANY: Any condition is met.

name

Yes

String

Backend name, which must start with a letter and can contain letters, digits, and underscores (_).

Minimum: 3

Maximum: 64

backend_params

No

Array of BackendParamBase objects

Backend parameters

conditions

Yes

Array of ApiConditionCreate objects

Policy conditions

authorizer_id

No

String

Backend custom authorizer ID.

function_urn

Yes

String

Function URN.

network_type

No

String

Network architecture type of the function. Options:

• V1: non-VPC

• V2: VPC

Default: V1

invocation_type

Yes

String

Invocation mode.

• async: asynchronous

• sync: synchronous

timeout

Yes

Integer

Timeout allowed for APIC to request the backend service. You can set the maximum timeout using the backend_timeout configuration item. The maximum value is 600,000.

Unit: ms

Minimum: 1

version

No

String

Version of a function.

If both the alias URN and version are specified, the version is ignored and only the alias URN is used.

Maximum: 64

alias_urn

No

String

Alias URN of a function.

If both the alias URN and version are specified, the version is ignored and only the alias URN is used.

effect_mode

Yes

String

Effective mode of the backend policy.

• ALL: All conditions are met.

• ANY: Any condition is met.

name

Yes

String

Backend name, which must start with a letter and can contain letters, digits, and underscores (_).

Minimum: 3

Maximum: 64

backend_params

No

Array of BackendParamBase objects

Backend parameters

conditions

Yes

Array of ApiConditionCreate objects

Policy conditions

authorizer_id

No

String

Backend custom authorizer ID.

name

Yes

String

Parameter name, which must start with a letter and can only contain letters, digits, hyphens (-), underscores (_), and periods (.).

Minimum: 1

Maximum: 32

location

Yes

String

Parameter location. The value can be PATH, QUERY, or HEADER.

origin

Yes

String

Parameter type. The value can be REQUEST, CONSTANT, and SYSTEM.

value

Yes

String

Parameter value, which can contain a maximum of 255 characters. If the origin type is REQUEST, the value of this field is the parameter name in req_params.

If the origin type is CONSTANT, the value of this field is the actual value of the parameter.

If the origin type is SYSTEM, the value of this parameter is the name of a system parameter. The system parameters are classified into gateway built-in parameters, frontend authentication parameters, and backend authentication parameters. When the frontend authentication mode of the API is customized, you can set frontend authentication parameters. When backend authentication is enabled for the API, you can set backend authentication parameters.

The gateway parameters include:

• $context.sourceIp: source address of the API caller

• $context.stage: deployment environment of API calling

• $context.apiName Name of the API

• $context.apiId: API ID

• $context.appName Name of the app object of the API caller

• $context.appId: ID of the app object of the API caller

• $context.requestId: ID of the trace generated during API calling

• $context.serverAddr: gateway server address

• $context.serverName: gateway server name

• $context.handleTime: API calling processing time

• $context.providerAppId: application object ID of the API owner, which is not supported currently

Value of a frontend authentication parameter: The prefix is $context.authorizer.frontend.. If you want to return aaa after the customized authentication verification, set this parameter to $context.authorizer.frontend.aaa.

Value of a backend authentication parameter: The prefix is $context.authorizer.backend.. If you want to return the parameter aaa after the customized authentication verification, set this parameter to $context.authorizer.backend.aaa.

Maximum: 255

remark

No

String

Description.

Maximum: 255

req_param_name

No

String

Input parameter name. This parameter is required if the policy type is param.

sys_param_name

No

String

System parameter name. This parameter is mandatory when the policy type is set to system. The following system parameters are supported:

• req_path: request path, such as /a/b

• req_method: request method, such as GET

cookie_param_name

No

String

COOKIE parameter name. This parameter is mandatory when the policy type is set to cookie.

condition_type

No

String

Policy condition.

• exact: exact match

• enum: enumeration

• pattern: regular expression

This parameter is required if the policy type is param or cookie.

condition_origin

Yes

String

Policy type.

• param: input parameter

• source: source IP address

• system: system parameter

• cookie: COOKIE parameter

condition_value

Yes

String

Policy value. This parameter is required if the policy type is param, source, or cookie.

authorizer_id

No

String

Backend custom authorizer ID.

url_domain

No

String

Address of the backend service. The value consists of the host (IP address or domain name) and port number. The total length cannot exceed 255 characters. The format is Host name:Port number (for example, apig.example.com:7443). If the port number is not specified, the default HTTPS port number is 443, and the default HTTP port number is 80. Environment variables are supported. If environment variables are used, each variable name is a string of 3 to 32 characters. The string consists of letters, digits, underscores (_), and hyphens (-), and must start with an English letter.

req_protocol

Yes

String

Request protocol.

remark

No

String

Description.

Maximum: 255

req_method

Yes

String

Request method.

version

No

String

Web backend version, which can contain a maximum of 16 characters.

req_uri

Yes

String

Request URI. The value can contain request parameters identified by braces ({}), for example, /getUserInfo/{userId}. Special characters such as * / / %- _ . are supported. The total length cannot exceed 512 characters and must meet the URI specifications.

Environment variables are supported. If environment variables are used, each variable name is a string of 3 to 32 characters. The string consists of letters, digits, hyphens (-), and underscores (_) and must start with an English letter.

timeout

Yes

Integer

Timeout allowed for ROMA Connect APIC to request the backend service. You can set the maximum timeout using the backend_timeout configuration item. The maximum value is 600,000.

Unit: ms

Minimum: 1

enable_client_ssl

No

Boolean

Whether to enable two-way authentication.

vpc_info

No

VpcInfoV1 object

VPC channel information.

vpc_status

No

Integer

Whether to use a VPC channel:

• 1: yes

• 2: no

url_domain

No

String

Endpoint of the policy backend. The value consists of a domain name (or an IP address) and a port number. The total length cannot exceed 255 characters. The value is in Domain name:Port number format, for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port number is 443 and the default HTTP port number is 80.Environment variables are supported. If environment variables are used, each variable name must contain 3 to 32 characters, including letters, digits, underscores (_), and hyphens (-). The value must start with a letter.

req_protocol

Yes

String

Request protocol. The value can be HTTP or HTTPS.

req_method

Yes

String

Request method. The value can be GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS or ANY.

req_uri

Yes

String

Request URI. The value can contain request parameters identified by braces ({}), for example, /getUserInfo/{userId}. Special characters such as * / / %- _ . are supported. The total length cannot exceed 512 characters and must meet the URI specifications. Environment variables are supported. If environment variables are used, each variable name is a string of 3 to 32 characters. The string consists of letters, digits, hyphens (-), and underscores (_) and must start with an English letter.

timeout

No

Integer

Timeout allowed for ROMA Connect APIC to request the backend service. You can set the maximum timeout using the backend_timeout configuration item. The maximum value is 600,000.

Unit: ms

Minimum: 1

enable_client_ssl

No

Boolean

Whether to enable two-way authentication.

effect_mode

Yes

String

Effective mode of the backend policy.

• ALL: All conditions are met.

• ANY: Any condition is met.

name

Yes

String

Backend name, which must start with a letter and can contain letters, digits, and underscores (_).

Minimum: 3

Maximum: 64

backend_params

No

Array of BackendParamBase objects

Backend parameters

conditions

Yes

Array of ApiConditionCreate objects

Policy conditions

authorizer_id

No

String

Backend custom authorizer ID.

vpc_info

No

VpcInfoV1 object

VPC channel information.

vpc_status

No

Integer

Whether to use a VPC channel:

• 1: yes

• 2: no

ecs_id

No

String

Cloud server ID.

ecs_name

No

Integer

Cloud server name.

cascade_flag

No

Boolean

Indicates whether to use the cascading mode.

This parameter is currently not supported.

vpc_proxy_host

No

String

Proxy host.

vpc_id

No

String

VPC channel ID.

vpc_port

No

String

VPC channel port.

name

String

API name.

The value can contain only letters, digits, hyphens (-), underscores (_), periods (.), slashes (/), parentheses, and colons (:). The value must start with a letter or digit.

Minimum: 3

Maximum: 255

type

Integer

API type.

• 1: public

• 2: private

version

String

API version.

Maximum: 16

req_protocol

String

API request protocol.

• HTTP

• HTTPS

• BOTH: Both HTTP and HTTPS are supported.

Default: HTTPS

req_method

String

API request method.

req_uri

String

Request URI. The value can contain request parameters identified by braces ({}), for example, /getUserInfo/{userId}. Special characters such as * / / %- _ . are supported. The total length cannot exceed 512 characters and must meet the URI specifications.

auth_type

String

API authentication mode. The options are as follows:

• NONE

• APP

• IAM

• AUTHORIZER (custom)

auth_opt

AuthOpt object

Security authentication parameter.

cors

Boolean

Whether CORS is supported.

• TRUE: supported

• FALSE: not supported

Default: false

match_mode

String

Match mode of an API.

• SWA: prefix match

• NORMAL: exact match (default) The default value is NORMAL.

backend_type

String

Backend type.

• HTTP: web backend

• FUNCTION: FunctionGraph backend

• MOCK: Mock backend

remark

String

Description of the API, which cannot contain < and >.

Minimum: 0

Maximum: 1000

group_id

String

ID of the API group to which the API belongs.

Minimum: 1

Maximum: 65

body_remark

String

API request body, which can be an example request body, media type, or parameters.

Maximum: 20480

result_normal_sample

String

Example response for a successful request.

Maximum: 20480

result_failure_sample

String

Example response for a failed request.

Maximum: 20480

authorizer_id

String

ID of the frontend custom authorizer.

Minimum: 1

Maximum: 65

tags

Array of strings

Tags.

The value can contain only letters, digits, and underscores (_), and must start with a letter. You can enter multiple tags and separate them with commas (,).

Minimum: 1

Maximum: 128

response_id

String

Group response ID.

This parameter is currently not supported.

Minimum: 1

Maximum: 65

roma_app_id

String

ID of the integration application to which an API belongs.

This parameter is mandatory when the API group is a global group or when an API is bound to a user-defined domain name.

Minimum: 1

Maximum: 65

domain_name

String

User-defined domain name bound to the API. If a user-defined domain name is used, the roma_app_id field is mandatory.

Maximum: 255

tag

String

Tag.

This field will be deprecated. You can use the tags field instead.

Maximum: 255

id

String

API ID.

status

Integer

API status:

• 1: Valid

arrange_necessary

Integer

Whether to enable orchestration.

register_time

String

Time when the API is registered.

update_time

String

Time when the API was last modified.

group_name

String

Name of the API group to which the API belongs.

group_version

String

Version of the API group to which the API belongs.

run_env_name

String

Name of the environment in which the API has been published.

Separate multiple environment names with vertical bars (|).

run_env_id

String

ID of the environment in which the API has been published.

Separate multiple environment IDs with vertical bars (|).

publish_id

String

Publication record ID.

Separate multiple publication record IDs with vertical bars (|).

roma_app_name

String

Name of the integration application to which the API belongs.

ld_api_id

String

ID of the corresponding custom backend API.

func_info

ApiFunc object

FunctionGraph backend details.

mock_info

ApiMock object

Mock backend details.

req_params

Array of ReqParam objects

Request parameters.

backend_params

Array of BackendParam objects

Backend parameters.

policy_functions

Array of ApiPolicyFunctionResp objects

FunctionGraph policy backend information.

policy_mocks

Array of ApiPolicyMockResp objects

Mock policy backend information.

backend_api

BackendApiV1 object

Web backend details

policy_https

Array of ApiPolicyHttpRespV1 objects

Web policy backends.

app_code_auth_type

String

Indicates whether AppCode authentication is enabled. This parameter is valid only if auth_type is set to App. The default value is DISABLE.

• DISABLE: AppCode authentication is disabled.

• HEADER: AppCode authentication is enabled and the AppCode is located in the header.

Default: DISABLE

function_urn

String

Function URN.

network_type

String

Network architecture type of the function. Options:

• V1: non-VPC

• V2: VPC

Default: V1

remark

String

Description.

Maximum: 255

invocation_type

String

Invocation mode.

• async: asynchronous

• sync: synchronous

version

String

Version of a function.

If both the alias URN and version are specified, the version is ignored and only the alias URN is used.

Maximum: 64

alias_urn

String

Alias URN of a function.

If both the alias URN and version are specified, the version is ignored and only the alias URN is used.

timeout

Integer

Timeout allowed for APIC to request the backend service. You can set the maximum timeout using the backend_timeout configuration item. The maximum value is 600,000.

Unit: ms

Minimum: 1

authorizer_id

String

Backend custom authorizer ID.

id

String

ID.

register_time

String

Registration time.

status

Integer

Backend status:

• 1: Valid

update_time

String

Modification time.

remark

String

Description.

Maximum: 255

result_content

String

Response.

version

String

Version. Ensure that the version does not exceed 64 characters.

authorizer_id

String

Backend custom authorizer ID.

status_code

Integer

Customized status code of the mock backend: "200": "OK", "201": "Created", "202": "Accepted", "203": "NonAuthoritativeInformation", "204": "NoContent", "205": "ResetContent", "206": "PartialContent", "300": "MultipleChoices", "301": "MovedPermanently", "302": "Found", "303": "SeeOther", "304": "NotModified", "305": "UseProxy", "306": "Unused", "307": "TemporaryRedirect", "400": "BadRequest", "401": "Unauthorized", "402": "PaymentRequired", "403": "Forbidden", "404": "NotFound", "405": "MethodNotAllowed", "406": "NotAcceptable", "407": "ProxyAuthenticationRequired", "408": "RequestTimeout", "409": "Conflict", "410": "Gone", "411": "LengthRequired", "412": "PreconditionFailed", "413": "RequestEntityTooLarge", "414": "RequestURITooLong", "415": "UnsupportedMediaType", "416": "RequestedRangeNotSatisfiable", "417": "ExpectationFailed", "450": "ParameterRequried", "451": "MethodConnectException", "500": "InternalServerError", "501": "NotImplemented", "502": "BadGateway", "503": "ServiceUnavailable", "504": "GatewayTimeout", "505": "HTTPVersionNotSupported"

header

String

Custom response header of the mock backend.

Format: [{"key":"","value": "", "remark:""}, {"key2":"","value2": "","remark2:""}]

Description:

key: key of the mock backend's custom response header. It must start with a letter or digit, and can include only letters, digits, and hyphens (-) (max. 64 characters).

value: value of the mock backend's custom response header. This parameter cannot be empty (max. 10,240 characters).

remark: remark of the mock backend's custom response header. This parameter can be empty (max. 2048 characters).

id

String

ID.

register_time

String

Registration time.

status

Integer

Backend status:

• 1: Valid

update_time

String

Modification time.

name

String

Parameter name. The value can contain letters, digits, hyphens (-), underscores (_), and periods (.) and must start with a letter.

Minimum: 1

Maximum: 32

type

String

Parameter type.

location

String

Parameter location.

default_value

String

Default value.

sample_value

String

Example value.

required

Integer

Indicates whether the parameter is mandatory.

• 1: The parameter is mandatory.

• 2: The parameter is optional.

The value of this parameter is 1 if Location is set to PATH, and 2 if Location is set to another value.

valid_enable

Integer

Indicates whether validity check is enabled.

• 1: enabled

• 2: disabled

Default: 2

remark

String

Description.

Maximum: 255

enumerations

String

Enumerated value.

min_num

Integer

Minimum value.

This parameter is valid when type is set to NUMBER.

max_num

Integer

Maximum value.

This parameter is valid when type is set to NUMBER.

min_size

Integer

Minimum length.

This parameter is valid when type is set to STRING.

max_size

Integer

Maximum length.

This parameter is valid when type is set to STRING.

regular

String

Regular expression validation rule.

This parameter is currently not supported.

json_schema

String

JSON validation rule.

This parameter is currently not supported.

pass_through

Integer

Indicates whether to transparently transmit the parameter.

• 1: The parameter is transparently transmitted.

• 2: The parameter is not transparently transmitted.

id

String

Parameter ID.

function_urn

String

Function URN.

network_type

String

Network architecture type of the function. Options:

• V1: non-VPC

• V2: VPC

Default: V1

invocation_type

String

Invocation mode.

• async: asynchronous

• sync: synchronous

timeout

Integer

Timeout allowed for APIC to request the backend service. You can set the maximum timeout using the backend_timeout configuration item. The maximum value is 600,000.

Unit: ms

Minimum: 1

version

String

Version of a function.

If both the alias URN and version are specified, the version is ignored and only the alias URN is used.

Maximum: 64

alias_urn

String

Alias URN of a function.

If both the alias URN and version are specified, the version is ignored and only the alias URN is used.

id

String

ID.

name

String

Backend name, which must start with a letter and can contain letters, digits, and underscores (_).

Minimum: 3

Maximum: 64

conditions

Array of ConditionResp objects

Policy conditions

backend_params

Array of BackendParam objects

Backend parameters

effect_mode

String

Effective mode of the backend policy.

• ALL: All conditions are met.

• ANY: Any condition is met.

authorizer_id

String

Backend custom authorizer ID.

Minimum: 1

Maximum: 65

id

String

ID.

name

String

Backend name, which must start with a letter and can contain letters, digits, and underscores (_).

Minimum: 3

Maximum: 64

conditions

Array of ConditionResp objects

Policy conditions

backend_params

Array of BackendParam objects

Backend parameters

effect_mode

String

Effective mode of the backend policy.

• ALL: All conditions are met.

• ANY: Any condition is met.

authorizer_id

String

Backend custom authorizer ID.

Minimum: 1

Maximum: 65

result_content

String

Response.

status_code

Integer

Customized status code of the mock backend: "200": "OK", "201": "Created", "202": "Accepted", "203": "NonAuthoritativeInformation", "204": "NoContent", "205": "ResetContent", "206": "PartialContent", "300": "MultipleChoices", "301": "MovedPermanently", "302": "Found", "303": "SeeOther", "304": "NotModified", "305": "UseProxy", "306": "Unused", "307": "TemporaryRedirect", "400": "BadRequest", "401": "Unauthorized", "402": "PaymentRequired", "403": "Forbidden", "404": "NotFound", "405": "MethodNotAllowed", "406": "NotAcceptable", "407": "ProxyAuthenticationRequired", "408": "RequestTimeout", "409": "Conflict", "410": "Gone", "411": "LengthRequired", "412": "PreconditionFailed", "413": "RequestEntityTooLarge", "414": "RequestURITooLong", "415": "UnsupportedMediaType", "416": "RequestedRangeNotSatisfiable", "417": "ExpectationFailed", "450": "ParameterRequried", "451": "MethodConnectException", "500": "InternalServerError", "501": "NotImplemented", "502": "BadGateway", "503": "ServiceUnavailable", "504": "GatewayTimeout", "505": "HTTPVersionNotSupported"

header

String

Custom response header of the mock backend.

Format: [{"key":"","value": "", "remark:""}, {"key2":"","value2": "","remark2:""}]

Description:

key: key of the mock backend's custom response header. It must start with a letter or digit, and can include only letters, digits, and hyphens (-) (max. 64 characters).

value: value of the mock backend's custom response header. This parameter cannot be empty (max. 10,240 characters).

remark: remark of the mock backend's custom response header. This parameter can be empty (max. 2048 characters).

req_param_name

String

Input parameter name. This parameter is required if the policy type is param.

sys_param_name

String

System parameter name. This parameter is mandatory when the policy type is set to system. The following system parameters are supported:

• req_path: request path, such as /a/b

• req_method: request method, such as GET

cookie_param_name

String

COOKIE parameter name. This parameter is mandatory when the policy type is set to cookie.

condition_type

String

Policy condition.

• exact: exact match

• enum: enumeration

• pattern: regular expression

This parameter is required if the policy type is param or cookie.

condition_origin

String

Policy type.

• param: input parameter

• source: source IP address

• system: system parameter

• cookie: COOKIE parameter

condition_value

String

Policy value. This parameter is required if the policy type is param, source, or cookie.

id

String

ID.

req_param_id

String

Input parameter ID.

req_param_location

String

Input parameter location.

name

String

Parameter name, which must start with a letter and can only contain letters, digits, hyphens (-), underscores (_), and periods (.).

Minimum: 1

Maximum: 32

location

String

Parameter location. The value can be PATH, QUERY, or HEADER.

origin

String

Parameter type. The value can be REQUEST, CONSTANT, and SYSTEM.

value

String

Parameter value, which can contain a maximum of 255 characters. If the origin type is REQUEST, the value of this field is the parameter name in req_params.

If the origin type is CONSTANT, the value of this field is the actual value of the parameter.

If the origin type is SYSTEM, the value of this parameter is the name of a system parameter. The system parameters are classified into gateway built-in parameters, frontend authentication parameters, and backend authentication parameters. When the frontend authentication mode of the API is customized, you can set frontend authentication parameters. When backend authentication is enabled for the API, you can set backend authentication parameters.

The gateway parameters include:

• $context.sourceIp: source address of the API caller

• $context.stage: deployment environment of API calling

• $context.apiName Name of the API

• $context.apiId: API ID

• $context.appName Name of the app object of the API caller

• $context.appId: ID of the app object of the API caller

• $context.requestId: ID of the trace generated during API calling

• $context.serverAddr: gateway server address

• $context.serverName: gateway server name

• $context.handleTime: API calling processing time

• $context.providerAppId: application object ID of the API owner, which is not supported currently

Value of a frontend authentication parameter: The prefix is $context.authorizer.frontend.. If you want to return aaa after the customized authentication verification, set this parameter to $context.authorizer.frontend.aaa.

Value of a backend authentication parameter: The prefix is $context.authorizer.backend.. If you want to return the parameter aaa after the customized authentication verification, set this parameter to $context.authorizer.backend.aaa.

Maximum: 255

remark

String

Description.

Maximum: 255

id

String

Parameter ID.

req_param_id

String

Request parameter ID.

authorizer_id

String

Backend custom authorizer ID.

url_domain

String

Address of the backend service. The value consists of the host (IP address or domain name) and port number. The total length cannot exceed 255 characters. The format is Host name:Port number (for example, apig.example.com:7443). If the port number is not specified, the default HTTPS port number is 443, and the default HTTP port number is 80. Environment variables are supported. If environment variables are used, each variable name is a string of 3 to 32 characters. The string consists of letters, digits, underscores (_), and hyphens (-), and must start with an English letter.

req_protocol

String

Request protocol.

remark

String

Description.

Maximum: 255

req_method

String

Request method.

version

String

Web backend version, which can contain a maximum of 16 characters.

req_uri

String

Request URI. The value can contain request parameters identified by braces ({}), for example, /getUserInfo/{userId}. Special characters such as * / / %- _ . are supported. The total length cannot exceed 512 characters and must meet the URI specifications.

Environment variables are supported. If environment variables are used, each variable name is a string of 3 to 32 characters. The string consists of letters, digits, hyphens (-), and underscores (_) and must start with an English letter.

timeout

Integer

Timeout allowed for ROMA Connect APIC to request the backend service. You can set the maximum timeout using the backend_timeout configuration item. The maximum value is 600,000.

Unit: ms

Minimum: 1

enable_client_ssl

Boolean

Whether to enable two-way authentication.

id

String

ID.

status

Integer

Backend status:

• 1: Valid

register_time

String

Registration time.

update_time

String

Modification time.

vpc_info

String

VPC channel information.

vpc_status

Integer

Whether to use a VPC channel:

• 1: yes

• 2: no

id

String

ID.

name

String

Backend name, which must start with a letter and can contain letters, digits, and underscores (_).

Minimum: 3

Maximum: 64

conditions

Array of ConditionResp objects

Policy conditions

backend_params

Array of BackendParam objects

Backend parameters

effect_mode

String

Effective mode of the backend policy.

• ALL: All conditions are met.

• ANY: Any condition is met.

authorizer_id

String

Backend custom authorizer ID.

Minimum: 1

Maximum: 65

url_domain

String

Endpoint of the policy backend. The value consists of a domain name (or an IP address) and a port number. The total length cannot exceed 255 characters. The value is in Domain name:Port number format, for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port number is 443 and the default HTTP port number is 80.Environment variables are supported. If environment variables are used, each variable name must contain 3 to 32 characters, including letters, digits, underscores (_), and hyphens (-). The value must start with a letter.

req_protocol

String

Request protocol. The value can be HTTP or HTTPS.

req_method

String

Request method. The value can be GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS or ANY.

req_uri

String

Request URI. The value can contain request parameters identified by braces ({}), for example, /getUserInfo/{userId}. Special characters such as * / / %- _ . are supported. The total length cannot exceed 512 characters and must meet the URI specifications. Environment variables are supported. If environment variables are used, each variable name is a string of 3 to 32 characters. The string consists of letters, digits, hyphens (-), and underscores (_) and must start with an English letter.

timeout

Integer

Timeout allowed for ROMA Connect APIC to request the backend service. You can set the maximum timeout using the backend_timeout configuration item. The maximum value is 600,000.

Unit: ms

Minimum: 1

enable_client_ssl

Boolean

Whether to enable two-way authentication.

vpc_info

String

VPC channel information.

vpc_status

Integer

Whether to use a VPC channel:

• 1: yes

• 2: no

error_code

String

Error code.

error_msg

String

Error description.

error_code

String

Error code.

error_msg

String

Error description.

error_code

String

Error code.

error_msg

String

Error description.

error_code

String

Error code.

error_msg

String

Error description.

error_code

String

Error code.

error_msg

String

Error description.

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error