Help Center/ API Gateway/ Dedicated API Gateway API Reference (Paris Region)/ Dedicated Gateway APIs (V2)/ API Management/ Querying the Runtime Definition of an API
Updated on 2023-12-19 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Runtime Definition of an API

Function

This API is used to query the runtime definition of an API in a specified environment. The runtime definition of an API in the RELEASE environment is queried if no environment is specified.

The definition of an API is classified into the following types:

  • Temporary definition: definition of an API used after the API was last edited.
  • Runtime definition: snapshot of the temporary definition of an API captured when the API is published in an environment.

The runtime definition of an API is accessed when the API is called in an environment.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/apis/runtime/{api_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

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.

api_id

Yes

String

API ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

env_id

No

String

ID of the environment in which the API is published.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

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.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

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

Enumeration values:

  • 1
  • 2

version

String

API version.

Maximum: 16

req_protocol

String

API request protocol:

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

Default: HTTPS

Enumeration values:

  • HTTP
  • HTTPS
  • BOTH

req_method

String

API request method.

Enumeration values:

  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY

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.

NOTE:

The address must comply with the URI specifications.

auth_type

String

API authentication mode.

  • NONE
  • APP
  • IAM
  • AUTHORIZER

Enumeration values:

  • NONE
  • APP
  • IAM
  • AUTHORIZER

auth_opt

AuthOpt object

Security authentication parameter.

cors

Boolean

Indicates whether CORS is supported.

  • TRUE: supported
  • FALSE: not supported

Default: false

Enumeration values:

  • true
  • false

match_mode

String

API matching mode:

  • SWA: Prefix match
  • NORMAL: Exact match Default value: NORMAL

Enumeration values:

  • SWA
  • 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.

Enumeration values:

  • HTTP
  • FUNCTION
  • MOCK

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.

result_failure_sample

String

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

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

Coming soon.

Enumeration values:

  • application/json
  • application/xml
  • multipart/form-data
  • text/plain

id

String

API ID.

group_name

String

Name of the API group to which the API belongs.

run_env_name

String

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

run_env_id

String

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

publish_id

String

Publication record ID.

sl_domain

String

Subdomain name of the API group.

sl_domains

Array of strings

Subdomain names that APIG automatically allocates to the API group.

req_params

Array of ReqParam objects

Request parameters.
Table 5 AuthOpt

Parameter

Type

Description

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

Enumeration values:

  • DISABLE
  • HEADER
Table 6 ReqParam

Parameter

Type

Description

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.

Enumeration values:

  • STRING
  • NUMBER

location

String

Parameter location.

Enumeration values:

  • PATH
  • QUERY
  • HEADER

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.

Enumeration values:

  • 1
  • 2

valid_enable

Integer

Indicates whether validity check is enabled.

  • 1: enabled
  • 2: disabled

Default: 2

Enumeration values:

  • 1
  • 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

Enumeration values:

  • 1
  • 2

id

String

Parameter ID.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

None

Example Responses

Status code: 200

OK

{
  "name" : "Api_http",
  "type" : 1,
  "version" : "V0.0.1",
  "req_protocol" : "HTTPS",
  "req_method" : "GET",
  "req_uri" : "/test/http",
  "auth_type" : "AUTHORIZER",
  "authorizer_id" : "8d0443832a194eaa84244e0c1c1912ac",
  "auth_opt" : {
    "app_code_auth_type" : "DISABLE"
  },
  "cors" : false,
  "match_mode" : "NORMAL",
  "backend_type" : "HTTP",
  "remark" : "Web backend API",
  "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
  "result_normal_sample" : "Example success response",
  "result_failure_sample" : "Example failure response",
  "id" : "5f918d104dc84480a75166ba99efff21",
  "group_name" : "api_group_001",
  "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
  "run_env_name" : "RELEASE",
  "publish_id" : "9191cdb430724d4b8586ed7f1b962ca2",
  "sl_domain" : "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com",
  "sl_domains" : [ "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com", "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.cn" ]
}

Status code: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Status code: 404

Not Found

{
  "error_code" : "APIG.3002",
  "error_msg" : "API 5f918d104dc84480a75166ba99efff21 does not exist"
}

Status code: 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Status Codes

Status Code

Description

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: API Management