Querying Details of 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

String

API name.

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

type

Integer

API type.

• 1: public

• 2: private

version

String

API version.

req_protocol

String

API request protocol. Options:

• HTTP

• HTTPS

• BOTH: Both HTTP and HTTPS are supported.

• GRPCS

req_method

String

API request method. If the request protocol is set to GRPC, the request method is fixed to POST.

req_uri

String

Request address. It can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks (*), slashes (/), percent signs (%), hyphens (-), underscores (_), and periods (.), are allowed. It can contain a maximum of 512 characters and must comply with the URI specifications.

If the request protocol is set to GRPC, the request address is fixed to /.

/apic/health_check is the preset health check path. If req_method is set to GET, req_uri=/apic/health_check is not supported.

auth_type

String

API authentication mode. Options:

• NONE: no authentication

• APP: App authentication

• IAM: IAM authentication

• AUTHORIZER: custom authentication. When auth_type is set to AUTHORIZER, the authorizer_id field is mandatory.

auth_opt

AuthOpt object

Security authentication parameter.

cors

Boolean

Whether CORS is supported.

• TRUE: supported

• FALSE: not supported

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. Options:

• HTTP: web backend

• FUNCTION: FunctionGraph backend. When backend_type is set to FUNCTION, func_info is mandatory.

• MOCK: Mock backend. When backend_type is set to MOCK, mock_info is mandatory.

• GRPC: gRPC backend.

Policy backends are not subject to this parameter.

remark

String

API description, with a maximum of 255 characters.

Angle brackets (<>) are not allowed.

group_id

String

ID of the API group to which the API belongs.

body_remark

String

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

result_normal_sample

String

Example response for a successful request.

This is unavailable if the request protocol is set to GRPC.

result_failure_sample

String

Example response for a failed request.

This is unavailable if the request protocol is set to GRPC.

authorizer_id

String

ID of the frontend custom authorizer.

tags

Array of strings

Tags

Use letters, digits, and special characters (-*#%.:_) and start with a letter.

By default, 10 tags are supported. To increase the quota, contact technical support to modify the API_TAG_NUM_LIMIT configuration.

response_id

String

Group response ID.

This parameter is currently not supported.

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.

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.

tag

String

Tag.

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

content_type

String

Request content type:

application/json

application/xml

multipart/form-data

text/plain

is_send_fg_body_base64

Boolean

Specifies whether to perform Base64 encoding on the body for interaction with FunctionGraph. The body does not need to be encoded using Base64 only when content_type is set to application/json.

Application scenarios:

• Custom authentication

• Bound circuit breaker plug-in with FunctionGraph backend downgrade policy

• APIs with FunctionGraph backend

id

String

API ID.

status

Integer

API status:

• 1: Valid

• 2: Locked

arrange_necessary

Integer

Whether to enable orchestration. Options: 1 (enable) and 2 (disable)

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 (|).

publish_time

String

Publication time.

Separate the time of multiple publication records 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.

backend_api

BackendApi object

Web backend details

api_group_info

ApiGroupCommonInfo object

API group information.

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 backends

policy_mocks

Array of ApiPolicyMockResp objects

Mock policy backend information.

policy_https

Array of ApiPolicyHttpResp 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.

authorizer_id

String

Backend custom authorizer ID.

url_domain

String

Backend service address If no VPC channel is used, url_domain is mandatory.

The value consists of the host (IP address or domain name) and port number with a maximum of 255 characters, in the format of host:port number (for example, apig.example.com:7443). If the port number is not specified, HTTPS port number defaults to 443 and HTTP port number defaults to 80.

Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

req_protocol

String

Request protocol. You can select GRPC or GRPCS for the GRPC backend.

remark

String

Description.

req_method

String

Request method. For the GRPC backend, the request method is fixed to POST.

version

String

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

req_uri

String

Request address. It can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks (*), slashes (/), percent signs (%), hyphens (-), underscores (_), and periods (.), are allowed. It can contain a maximum of 512 characters and must comply with URI specifications.

Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

For the GRPC backend, the request address is fixed to /.

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

enable_client_ssl

Boolean

Whether to enable two-way authentication.

retry_count

String

Number of retry attempts to request the backend service. Default: –1. Range: –1 to 10.

–1 indicates that idempotent APIs will retry once and non-idempotent APIs will not retry. POST and PATCH are non-idempotent. GET, HEAD, PUT, OPTIONS, and DELETE are idempotent.

enable_sm_channel

Boolean

Whether to enable SM cryptographic algorithms.

This feature is only available if the instance supports the SM cryptographic algorithms.

id

String

ID.

status

Integer

Backend status:

• 1: Valid

register_time

String

Registration time.

update_time

String

Modification time.

vpc_channel_info

VpcInfo object

VPC channel details. This parameter is required if vpc_channel_status is set to 1.

vpc_channel_status

Integer

Whether to use a VPC channel:

• 1: yes

• 2: no

id

String

No.

name

String

API group name.

status

Integer

Status.

• 1: Valid

• 2: Locked

sl_domain

String

Subdomain name that the system automatically allocates to the API group.

register_time

String

Creation time.

update_time

String

Last modification time.

on_sell_status

Integer

Indicates whether the API group has been listed on the marketplace. The value can be:

• 1: published

• 2: not published

• 3: being reviewed

ROMA Connect is not connected to the marketplace. The default value 2 is returned.

url_domains

Array of UrlDomain objects

List of independent domain names bound to the API group.

sl_domain_access_enabled

Boolean

Whether the debugging domain name is accessible. Options: true and false.

id

String

Domain ID.

domain

String

Domain name.

cname_status

Integer

CNAME resolution status of the domain name.

• 1: not resolved

• 2: resolving

• 3: resolved

• 4: resolving failed

ssl_id

String

SSL certificate ID.

ssl_name

String

SSL certificate name.

min_ssl_version

String

Minimum SSL version. TLS 1.1 and TLS 1.2 are supported.

verified_client_certificate_enabled

Boolean

Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist.

is_has_trusted_root_ca

Boolean

Whether a trusted root certificate (CA) exists. The value is true if trusted_root_ca exists in the bound certificate.

ssl_infos

Array of SslInfo objects

SSL certificate list.

ssl_id

String

SSL certificate ID.

ssl_name

String

SSL certificate name.

algorithm_type

String

Certificate algorithm type:

• RSA

• ECC

• SM2

type

String

Certificate scope. Options:

• instance: current instance

• global: all instances

function_urn

String

Function URN.

network_type

String

Network architecture type of the function. Options:

• V1: non-VPC

• V2: VPC

remark

String

Description.

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.

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

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.

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.

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

remark

String

Description.

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.

orchestrations

Array of strings

Request parameter orchestration rules.

Request parameter orchestration rules are prioritized in the same sequence as the list.

The none_value rule in a rule list has the highest priority. A maximum of one none_value rule can be bound.

The default rule in a rule list has the lowest priority. A maximum of one default rule can be bound.

The preprocessing orchestration rule cannot be used as the last orchestration rule except the default rule.

Only one parameter of each API can be bound with unique orchestration rules. The number of orchestration rules that can be bound is limited by quota. For details, see "Quotas" in ROMA Connect Service Overview.

id

String

Parameter ID.

function_urn

String

Function URN.

network_type

String

Network architecture type of the function. Options:

• V1: non-VPC

• V2: VPC

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

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.

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 (_).

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.

id

String

ID.

name

String

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

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.

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).

id

String

ID.

name

String

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

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.

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. Options include HTTP, HTTPS, GRPC, or GRPCS. You can select GRPC or GRPCS for the GRPC backend.

req_method

String

Request method. Options: GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS, and ANY. This is fixed to POST for the GRPC backend.

req_uri

String

Request address. It can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks (*), slashes (/), percent signs (%), hyphens (-), underscores (_), and periods (.), are allowed. It can contain a maximum of 512 characters and must comply with URI specifications.

Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

For the GRPC backend, the request address is fixed to /.

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

enable_client_ssl

Boolean

Whether to enable two-way authentication.

retry_count

String

Number of retry attempts to request the backend service. Default: –1. Range: –1 to 10.

–1 indicates that idempotent APIs will retry once and non-idempotent APIs will not retry. POST and PATCH are non-idempotent. GET, HEAD, PUT, OPTIONS, and DELETE are idempotent.

enable_sm_channel

Boolean

Whether to enable SM cryptographic algorithms.

This feature is only available if the instance supports the SM cryptographic algorithms.

vpc_channel_info

VpcInfo object

VPC channel details. This parameter is required if vpc_channel_status is set to 1.

vpc_channel_status

Integer

Whether to use a VPC channel:

• 1: yes

• 2: no

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 required if the policy type is cookie.

frontend_authorizer_param_name

String

Frontend authorizer parameter name (system parameter). This parameter is required if the policy type is frontend_authorizer. The frontend authentication parameter name is prefixed with $context.authorizer.frontend. For example, if the frontend authentication parameter name is user_name, add the prefix and the value is $context.authorizer.frontend.user_name.

condition_type

String

Policy condition.

• exact: Exact match.

• enum: Enumeration.

• pattern: Regular expression.

This parameter is mandatory when the policy type is param, cookie, or frontend_authorizer.

condition_origin

String

Policy type

• param: Parameter.

• source: Source IP.

• system: Built-in gateway parameter (system parameter).

• cookie: COOKIE parameter.

• frontend_authorizer: Frontend authorizer parameter (system parameter).

• orchestration: Parameter orchestration rule.

condition_value

String

Policy value, which is required when the policy type is param, source, cookie, or frontend_authorizer.

mapped_param_name

String

Name of a parameter generated after orchestration. This parameter is mandatory when condition_origin is set to orchestration. The generated parameter name must exist in the orchestration rule bound to the API.

mapped_param_location

String

Location of a parameter generated after orchestration. This parameter is mandatory when condition_origin is set to orchestration. This location must exist in the orchestration rule bound to the API.

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 (.).

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, with a maximum of 255 characters.

If the origin type is REQUEST, the value of this parameter is the parameter name in req_params.

If the origin type is CONSTANT, the value is a constant.

If the origin type is SYSTEM, the value is a system parameter name. System parameters include gateway parameters, frontend authentication parameters, and backend authentication parameters. You can set the frontend or backend authentication parameters after enabling custom frontend or backend authentication.

The gateway parameters are as follows:

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

• $context.stage: deployment environment in which the API is called

• $context.apiName: API name

• $context.apiId: API ID

• $context.appName: name of the app used by the API caller

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

• $context.requestId: request ID generated when the API is called

• $context.serverAddr: address of the gateway server

• $context.serverName: name of the gateway server

• $context.handleTime: processing time of the API request

• $context.providerAppId: ID of the app used by the API owner (not supported)

• $context.clientCertCN: client certificate CN carried in the API invoking when client authentication is enabled

Frontend authentication parameter: prefixed with "$context.authorizer.frontend.". For example, to return "aaa" upon successful custom authentication, set this parameter to "$context.authorizer.frontend.aaa".

Backend authentication parameter: prefixed with "$context.authorizer.backend.". For example, to return "aaa" upon successful custom authentication, set this parameter to "$context.authorizer.backend.aaa".

remark

String

Description.

id

String

Parameter ID.

req_param_id

String

Request parameter ID.

ecs_id

String

Cloud server ID.

ecs_name

String

Cloud server name.

cascade_flag

Boolean

Indicates whether to use the cascading mode.

This parameter is currently not supported.

vpc_channel_proxy_host

String

Proxy host.

vpc_channel_id

String

VPC channel ID.

vpc_channel_port

Integer

VPC channel port.

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

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error