Querying API Version Details

project_id

Yes

String

Project ID. For details about how to obtain it, see Obtaining a Project ID.

instance_id

Yes

String

Gateway ID, which can be obtained from the gateway information on the APIG console.

version_id

Yes

String

API version.

X-Auth-Token

Yes

String

User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

name

String

API name.

It can contain 3 to 255 characters, starting with a letter or digit. Only letters, digits, and these special characters are allowed: -_./:()

type

Integer

API type.

• 1: public API
• 2: private API

version

String

API version.

Maximum: 16

req_protocol

String

API request protocol:

• HTTP
• HTTPS
• BOTH: Both HTTP and HTTPS are supported.
• GRPCS

Default: HTTPS

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, which 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.

auth_type

String

API authentication mode. Options:

• NONE
• APP
• IAM
• 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

Indicates whether CORS is supported.

• TRUE: supported
• FALSE: not supported

Default: false

match_mode

String

API matching mode:

• SWA: Prefix match
• NORMAL: Exact match

  Default value: NORMAL

backend_type

String

Backend type. Options:

• HTTP: web backend
• FUNCTION: FunctionGraph backend. When backend_type is set to FUNCTION, the func_info field is mandatory.
• MOCK: mock backend. When backend_type is set to MOCK, the mock_info field is mandatory.
• GRPC: gRPC backend.

remark

String

API description. It cannot exceed 255 characters.

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. Ensure that the request body does not exceed 20,480 characters.

result_normal_sample

String

Example response for a successful request. Ensure that the response does not exceed 20,480 characters.

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

result_failure_sample

String

Example response for a failed request. Ensure that the response does not exceed 20,480 characters.

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

authorizer_id

String

ID of the frontend custom authorizer

tags

Array of strings

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

Minimum: 1

Maximum: 128

response_id

String

Group response ID.

roma_app_id

String

Integration application ID.

Currently, this parameter is not supported.

domain_name

String

Custom domain name bound to the API.

Currently, this parameter is not supported.

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 scenario:

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

Default: true

id

String

API ID.

status

Integer

App status.

• 1: valid

arrange_necessary

Integer

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

The default value is V1. Other versions are not supported.

Default: V1

run_env_id

String

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

Separate multiple environment IDs with vertical bars (|).

run_env_name

String

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

Separate multiple environment names with vertical bars (|).

publish_id

String

Publication record ID.

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

publish_time

String

Time when the API version is published.

roma_app_name

String

Name of the integration application to which the API belongs.

Currently, this parameter is not supported.

ld_api_id

String

ID of the corresponding custom backend API.

Currently, this parameter is not supported.

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 backend policies.

policy_mocks

Array of ApiPolicyMockResp objects

Mock backend policies.

policy_https

Array of ApiPolicyHttpResp objects

Web backend policies.

sl_domain

String

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

sl_domains

Array of strings

Subdomain names that APIG automatically allocates to the API group.

version_id

String

API version ID.

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

authorizer_id

String

Backend custom authorizer ID.

url_domain

String

Backend service address.

A backend service address consists of a domain name or IP address and a port number, with not more than 255 characters. It must be in the format "Host name:Port number", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443 or the default HTTP port 80 is used.

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. It cannot exceed 255 characters.

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, which 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 APIG 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

Indicates whether to enable two-way authentication.

retry_count

String

Number of retry attempts to request the backend service. The default value is –1. The value ranges from –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.

Default: -1

enable_sm_channel

Boolean

Indicates whether to enable SM cryptographic algorithms.

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

id

String

ID.

status

Integer

Backend service status.

• 1: valid

register_time

String

Registration time.

update_time

String

Update 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

Indicates whether to use a VPC channel.

• 1: A VPC channel is used.
• 2: No VPC channel is used.

id

String

ID.

name

String

API group name.

status

Integer

Status.

• 1: valid

sl_domain

String

Subdomain name that APIG 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 KooGallery.

• 1: listed
• 2: not listed
• 3: under review

Not supported currently.

url_domains

Array of UrlDomain objects

Independent domain names bound to the API group.

sl_domain_access_enabled

Boolean

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

Default: true

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

Default: TLSv1.1

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.

Default: false

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.

Default: false

ingress_http_port

Integer

Inbound HTTP port bound to the domain name. -1 indicates that no port is available and the protocol is not supported. In this case, you can use the default port 80. Other valid ports must be included in the HTTP inbound ports of the gateway. The value ranges from 1024 to 49151.

When creating a domain name, if this parameter is not set, the default port 80 is used. If this parameter is set, https_port must be set. If both http_port and https_port need to use the default port, leave both parameters blank.

If this parameter is not specified when you modify the domain name, the port number remains unchanged.

Minimum: -1

Maximum: 49151

ingress_https_port

Integer

Inbound HTTPS port bound to the domain name. -1 indicates that no port is available and the protocol is not supported. In this case, you can use the default port 443. Other valid ports must be included in the HTTPS inbound ports of the gateway. The value ranges from 1024 to 49151.

When creating a domain name, if this parameter is not set, the default port 443 is used. If this parameter is set, http_port must be set. If both http_port and https_port need to use the default port, leave both parameters blank.

If this parameter is not specified when you modify the domain name, the port number remains unchanged.

Minimum: -1

Maximum: 49151

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:

• instance
• global

Default: global

function_urn

String

Function URN.

remark

String

Description. It cannot exceed 255 characters.

invocation_type

String

Invocation mode.

• async: asynchronous
• sync: synchronous

network_type

String

Function network architecture.

• V1: non-VPC
• V2: VPC

version

String

Function version.

If both a function alias URN and version are passed, only the alias URN will be used.

Maximum: 64

alias_urn

String

Function alias URN.

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

timeout

Integer

Timeout allowed for APIG to request the backend service. If the function network architecture is set to V1, the maximum timeout is 60,000. If the network architecture is set to V2, the maximum timeout is 600,000 and can be modified by using the gateway parameter backend_timeout.

Unit: ms.

Minimum: 1

authorizer_id

String

Backend custom authorizer ID.

req_protocol

String

Backend request protocol of a function. The value can be HTTPS (default) or GRPCS (available when the frontend request protocol is GRPCS).

Default: HTTPS

id

String

ID.

register_time

String

Registration time.

status

Integer

Backend service status.

• 1: valid

update_time

String

Update time.

remark

String

Description. It cannot exceed 255 characters.

result_content

String

Response.

version

String

Function version. It cannot exceed 64 characters.

authorizer_id

String

Backend custom authorizer ID.

id

String

ID.

register_time

String

Registration time.

status

Integer

Backend service status.

• 1: valid

update_time

String

Update time.

name

String

Parameter name.

The parameter name can contain 1 to 32 characters and must start with a letter. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.

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

1: yes

2: no

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. It cannot exceed 255 characters.

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.

Currently, this parameter is not supported.

json_schema

String

JSON validation rule.

Currently, this parameter is not supported.

pass_through

Integer

Indicates whether to transparently transfer the parameter.

1: yes

2: no

orchestrations

Array of strings

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 "Notes and Constraints" in APIG Service Overview.

id

String

Parameter ID.

function_urn

String

Function URN.

invocation_type

String

Invocation mode.

• async: asynchronous
• sync: synchronous

network_type

String

Function network architecture.

• V1: non-VPC
• V2: VPC

version

String

Function version.

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

Maximum: 64

alias_urn

String

Function alias URN.

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

timeout

Integer

Timeout allowed for APIG to request the backend service. If the function network architecture is set to V1, the maximum timeout is 60,000. If the network architecture is set to V2, the maximum timeout is 600,000 and can be modified by using the gateway parameter backend_timeout.

Unit: ms.

Minimum: 1

req_protocol

String

Backend request protocol of a function. The value can be HTTPS (default) or GRPCS (available when the frontend request protocol is GRPCS).

Default: HTTPS

id

String

ID.

effect_mode

String

Effective mode of the backend policy.

• ALL: All conditions are met.
• ANY: Any condition is met.

name

String

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

Minimum: 3

Maximum: 64

backend_params

Array of BackendParam objects

Backend parameters.

conditions

Array of CoditionResp objects

Policy conditions.

authorizer_id

String

Backend custom authorizer ID.

id

String

ID.

effect_mode

String

Effective mode of the backend policy.

• ALL: All conditions are met.
• ANY: Any condition is met.

name

String

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

Minimum: 3

Maximum: 64

backend_params

Array of BackendParam objects

Backend parameters.

conditions

Array of CoditionResp objects

Policy conditions.

authorizer_id

String

Backend custom authorizer ID.

result_content

String

Response.

id

String

ID.

effect_mode

String

Effective mode of the backend policy.

• ALL: All conditions are met.
• ANY: Any condition is met.

name

String

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

Minimum: 3

Maximum: 64

backend_params

Array of BackendParam objects

Backend parameters.

conditions

Array of CoditionResp objects

Policy conditions.

authorizer_id

String

Backend custom authorizer ID.

url_domain

String

Endpoint of the policy backend.

An endpoint consists of a domain name or IP address and a port number, with not more than 255 characters. It must be in the format "Domain name:Port number", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443

or the default HTTP port 80 is used.

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

req_method

String

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

req_uri

String

Request address, which 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 APIG 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

retry_count

String

Number of retry attempts to request the backend service. The default value is –1. The value ranges from –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.

Default: -1

enable_sm_channel

Boolean

Indicates whether to enable SM cryptographic algorithms.

This feature is only available if the gateway 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

Indicates whether to use a VPC channel.

• 1: A VPC channel is used.
• 2: No VPC channel is used.

origin

String

Parameter type.

• REQUEST: backend parameter
• CONSTANT: constant parameter
• SYSTEM: system parameter

name

String

Parameter name.

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

Minimum: 1

Maximum: 32

remark

String

Description, which can contain a maximum of 255 characters.

location

String

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

value

String

Parameter value, which can contain 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.apiId: API ID.
• $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: time when the API request is processed.
• $context.providerAppId: ID of the app used by the API owner. This parameter is currently not supported.

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

id

String

Parameter ID.

req_param_id

String

Request parameter ID.

req_param_name

String

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

sys_param_name

String

Name of a built-in gateway parameter. This parameter is required if the policy type is system. The following parameters are supported:

• req_path: request path. For example, /a/b.
• req_method: request method. For example, GET.
• reqPath: request path, which is discarded. For example, /a/b.
• reqMethod: request method, which is discarded. For example, GET.

cookie_param_name

String

COOKIE parameter name. This parameter is required if the policy type is cookie.

Minimum: 0

Maximum: 255

frontend_authorizer_param_name

String

System parameter: frontend authentication parameter name. This parameter is mandatory when 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, the name with the prefix will be $context.authorizer.frontend.user_name.

condition_type

String

Policy condition.

• exact: Exact match
• enum: Enumeration
• pattern: Regular expression

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

condition_origin

String

Policy type

• param: parameter
• source: source IP address
• system: system parameter - gateway built-in parameter
• cookie: COOKIE parameter
• frontend_authorizer: system parameter - frontend authentication parameter

condition_value

String

Policy value.

Maximum: 1024

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.

ecs_id

String

Cloud server ID.

ecs_name

String

Cloud server name.

cascade_flag

Boolean

Indicates whether to use the cascading mode.

Currently, this parameter is 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 message.

error_code

String

Error code.

error_msg

String

Error message.

error_code

String

Error code.

error_msg

String

Error message.

error_code

String

Error code.

error_msg

String

Error message.

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error