Help Center/ ROMA Connect/ API Reference/ Service Integration APIs/ API Management/ Querying the Runtime Definition of an API
Updated on 2023-06-29 GMT+08:00
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.

URI

GET /v2/{project_id}/apic/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 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.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

env_id

No

String

ID of the environment in which the API was published.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

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.

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. /apic/health_check indicates the health check path preset for service integration. When req_method is set to GET, req_uri cannot be set to /apic/health_check. The value must comply with the URI specifications.

auth_type

String

API authentication mode.

  • NONE

  • APP

  • IAM

  • AUTHORIZER

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 letters, digits, and special characters (-*#%.:_) and must start with a letter. You can enter multiple tags and separate them with commas (,).

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.

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

content_type

String

Request content type:

application/json application/xml multipart/form-date 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

Automatically allocated subdomain names.

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
Table 6 ReqParam

Parameter

Type

Description

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.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

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" : "Normal response example",
  "result_failure_sample" : "Failure response example",
  "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