Struct descriptions

Updated at:
Copy as MD

This topic provides a reference for the API structs in API Gateway, including their descriptions, fields, and examples.

AppInfoVO

Name

Type

Required

Example

Description

api_count

NUMBER

No

1

The number of APIs.

app_id

STRING

No

app_id

App ID

app_name

STRING

No

app_name

The application name.

app_secret

STRING

No

app_secret1

appSecret

app_type

STRING

No

STANDARD / MPAAS

The application type.

authentication_config

AuthenticationConfigVO

No

-

The authorization configuration.

description

STRING

No

description

The application description.

encrypt_config

EncryptConfigVO

No

-

The encryption configuration.

gmt_create

DATE

No

2018-10-10T10:10:00Z

The creation time.

gmt_modified

DATE

No

2018-10-10T10:10:00Z

The modification time.

operator

STRING

No

scott

The operator.

tenant_id

STRING

No

tenant_id

The tenant ID.

workspace_id

STRING

No

workspace_id

The workspace ID.

AppInfoQueryVO

Name

Type

Required

Example

Description

page_info

PageInfo

No

-

Paging information.

query

AppInfoVO

No

-

The query.

AppInfoPagedListVO

Name

Type

Required

Example

Description

list

ARRAY[AppInfoVO]

No

-

The list.

page_info

PageInfo

No

-

Paging information.

AuthAppInfoVO

Name

Type

Required

Example

Description

api_count

NUMBER

No

1

The number of APIs.

app_type

STRING

No

MPAAS/STANDARD

The application type.

authentication_type

STRING

No

NONE / SECRET

The authentication method.

auth_app_info_id

STRING

No

8Amfi67dmE9wpY46

The authorized application ID.

auth_app_type

STRING

No

OUTER / INNER

The source of the authorized application (internal or external).

encrypt_type

STRING

No

NONE / RSA / ECC / SM

The encryption type.

gmt_create

DATE

No

2018-10-10T10:10:00Z

The creation time.

gmt_modified

DATE

No

2018-10-10T10:10:00Z

The modification time.

operator

STRING

No

scott

The operator.

sub_app_company

STRING

No

sub_app_company1

The company information of the subscribing application.

sub_app_desc

STRING

No

sub_app_desc1

The description of the subscribing application.

sub_app_id

STRING

No

sub_app_id

The ID of the subscribing application.

sub_app_info

AppInfoVO

No

-

The information of the subscribing application.

sub_tenant_id

STRING

No

sub_tenant_id1

The tenant ID of the subscribing application.

sub_workspace_id

STRING

No

sub_workspace_id1

The workspace ID of the subscribing application.

AuthAppInfoQueryVO

Name

Type

Required

Example

Description

page_info

PageInfo

No

-

Paging information.

query

AuthAppInfoVO

No

-

The query.

AuthAppInfoPagedListVO

Name

Type

Required

Example

Description

list

ARRAY[AuthAppInfoVO]

No

-

The list.

page_info

PageInfo

No

-

Paging information.

SystemClusterVO

Name

Type

Required

Example

Description

api_count

NUMBER

No

1

The number of APIs.

authentication_config

AuthenticationConfigVO

No

-

The authentication configuration.

authentication_type

STRING

No

SECRET/NONE

The authentication method.

description

STRING

No

Test system

The description.

gmt_create

DATE

No

2018-10-10T10:10:00Z

The creation time.

gmt_modified

DATE

No

2018-10-10T10:10:00Z

The modification time.

host

ARRAY[STRING]

No

-

The host addresses of the system.

lb_type

STRING

No

RAMDOM / ROUND_ROBIN

The load balancing policy type.

operator

STRING

No

scott

The creator.

sys_id

STRING

No

8Amfi67dmE9wpY46

The system ID.

sys_name

STRING

No

test_sys

The system name.

sys_type

STRING

No

URL / SOFA

System Type (Manual Configuration / SOFA Registry / ZooKeeper)

tenant_id

STRING

No

TSCPDICNT

The tenant ID.

upstream_protocol

STRING

No

HTTP / SOFA

The backend protocol type.

workspace_id

STRING

No

default

The workspace ID.

SystemClusterQueryVO

Name

Type

Required

Example

Description

page_info

PageInfo

No

-

Paging information.

query

SystemClusterVO

No

-

The query.

SystemClusterPagedListVO

Name

Type

Required

Example

Description

list

ARRAY[SystemClusterVO]

No

-

The list.

page_info

PageInfo

No

-

Paging information.

ApiInfoVO

Name

Type

Required

Example

Description

api_cache_model

ApiCacheVO

No

-

The API cache model.

api_group_id

STRING

No

api_group_id1

The API group ID.

api_group_name

STRING

No

api_group_name1

The name of the API group.

api_id

STRING

No

8Amfi67dmE9wpY46

The API ID.

api_limit_config

LimitConfigVO

No

-

The API rate limiting configuration.

api_mock_config

ApiMockConfigVO

No

api_mock_config

The API mock configuration.

api_name

STRING

No

apiname1

The API name.

api_status

STRING

No

OPENED / CLOSED

The API status.

app_type

STRING

No

MPAAS/STANDARD/STANDARD_AND_MPAAS

The authorized application type.

authentication_type

STRING

No

NONE / SECRET

The API authentication method.

auth_app_count

NUMBER

No

2

The number of authorized applications.

can_delete

BOOLEAN

No

true, false

Deletable

charset

STRING

No

UTF-8

The message encoding.

content_type

STRING

No

content_type1

The content type.

cors_info

CorsInfoVO

No

-

The API Cross-Origin Resource Sharing (CORS) information.

description

STRING

No

description1

The API description.

domain_name

STRING

No

test.apigateway.com

The domain name of the API group.

downstream_protocol

STRING

No

HTTP

The frontend protocol type.

edit_version

ApiVersionVO

No

The version being edited.

The version being edited.

edit_version_no

STRING

No

edit_version_no1

The version number of the API being edited.

function_name

STRING

No

getUserID

The method name.

gmt_create

DATE

No

2018-10-10T10:10:00Z

The creation time.

gmt_modified

DATE

No

2018-10-10T10:10:00Z

The modification time.

history_version_list

ARRAY[ApiVersionVO]

No

The list of historical versions.

The list of historical versions.

interface_name

STRING

No

com.alipay.HelloFacade:1.0@DEFAULT

The interface name.

method

STRING

No

method1

The method.

online_version

ApiVersionVO

No

The online version.

The online version.

online_version_no

STRING

No

online_version_no1

The version number of the API being published.

operation_type

STRING

No

operation_type1

operationType

operator

STRING

No

operator

The creator.

path

STRING

No

path1

Path

path_match_type

STRING

No

ABSOLUTE / PREFIX

The path matching type.

req_params

ARRAY[ApiParamVO]

No

-

The request parameters.

router_id

STRING

No

8Amfi67dmE9wpY46

router_id

router_info

RouterInfoVO

No

-

The routing rule.

router_type

STRING

No

PATH / HEADER / WEIGHT

The routing policy type.

rsq_param

ApiParamVO

No

-

rsqParam

system_cluster

SystemClusterVO

No

-

The system cluster.

sys_id

STRING

No

8Amfi67dmE9wpY46

The system cluster ID.

tenant_id

STRING

No

tenant1

The tenant ID.

timeout

NUMBER

No

123

The timeout period in milliseconds (ms).

upstream_path

STRING

No

upstream_path1

upstreamPath

upstream_protocol

STRING

No

HTTP / SOFA / SOFA_VPC

The backend protocol type.

upstream_type

STRING

No

NONE / MOCK / SYSTEM_CLUSTER

The backend service type.

workspace_id

STRING

No

default

The workspace ID.

ApiInfoQueryVO

Name

Type

Required

Example

Description

page_info

PageInfo

No

-

Paging information.

query

ApiInfoVO

No

-

The query.

ApiInfoPagedListVO

Name

Type

Required

Example

Description

list

ARRAY[ApiInfoVO]

No

-

The list.

page_info

PageInfo

No

-

Paging information.

ApiVersionVO

Name

Type

Required

Example

Description

api_id

STRING

No

api_id1

The API ID.

edit_operator

STRING

No

scott

Edit Operator

gmt_create

DATE

No

2018-10-10T10:10:00Z

The creation time.

gmt_edit

DATE

No

2018-10-10T10:10:00Z

The edit time.

gmt_modified

DATE

No

2018-10-10T10:10:00Z

The modification time.

gmt_offline

DATE

No

2018-10-10T10:10:00Z

gmtOffline

gmt_online

DATE

No

2018-10-10T10:10:00Z

gmtOnline

offline_desc

STRING

No

offline_desc1

The description for unpublishing.

offline_operator

STRING

No

scott

The operator who unpublished the version.

online_desc

STRING

No

online_desc1

The reason for publishing.

online_operator

STRING

No

online_operator1

The operator who published the version.

version_id

STRING

No

4438Y8yXxU0cYrgS

The version ID.

version_no

STRING

No

1.2

The version number.

version_status

STRING

No

EDIT / ONLINE / OFFLINE

The version status.

ApiRspCodeVO

Name

Type

Required

Example

Description

error_code

STRING

No

error_code

The error code.

error_desc

STRING

No

error_desc

The description.

error_msg

STRING

No

error_msg

The error message.

ApiParamVO

Name

Type

Required

Example

Description

api_id

STRING

No

api_id1

The API ID.

default_value

STRING

No

value1

default_value

description

STRING

No

description1

The description.

failure_demo

STRING

No

failure_demo

failure_demo

location

STRING

No

Query / Path / Header / …

The location.

name

STRING

No

name1

The name.

ref_type

STRING

No

String

The referenced model type.

required

BOOLEAN

No

-

Indicates whether the parameter is required.

rsp_code_list

ARRAY[ApiRspCodeVO]

No

-

rsp_code_list

success_demo

STRING

No

success_demo

success_demo

type

STRING

No

String / Int / Long / Float / Double / Boolean / …

The data type.

workspace_id

STRING

No

default

The workspace ID.

ApiMockConfigVO

Name

Type

Required

Example

Description

mock_data

STRING

No

mock_data

The mock data.

ApiTestParamVO

Name

Type

Required

Example

Description

key

STRING

No

key1

Key

location

STRING

No

HEADER/QUERY

The location.

value

STRING

No

value1

Value

ApiTestReqVO

Name

Type

Required

Example

Description

api_id

STRING

No

api_id1

The API ID.

app_id

STRING

No

app_id1

The application ID.

auth_app_info_id

STRING

No

auth_app_info_id1

The authorized application ID.

params

ARRAY[ApiTestParamVO]

No

-

Parameters

payload

STRING

No

payload1

payload

tenant_id

STRING

No

tenant_id

The tenant ID.

workspace_id

STRING

No

default

The workspace ID.

ApiTestRspVO

Name

Type

Required

Example

Description

code

STRING

No

code1

code

cost

NUMBER

No

1000

The cost.

headers

ARRAY[ApiTestParamVO]

No

-

Headers

payload

STRING

No

payload1

payload

size

NUMBER

No

1000

The size.

ApiCacheKeyVO

Name

Type

Required

Example

Description

key

STRING

No

key1

Key

location

STRING

No

HEADER/QUERY/BODY

The location.

value

STRING

No

value1

Value

ApiCacheVO

Name

Type

Required

Example

Description

cache_keys

ARRAY[ApiCacheKeyVO]

No

-

cacheKeys

need_cache

BOOLEAN

No

true, false

Indicates whether caching is needed.

ttl

NUMBER

No

10000

TTL

ApiGroupVO

Name

Type

Required

Example

Description

api_count

NUMBER

No

-

The number of APIs.

api_group_id

STRING

No

3778911001abc

The group ID, which is globally unique.

description

STRING

No

This is a description.

The description.

domain_name

STRING

No

-

The domain name.

gmt_create

DATE

No

2018-10-10T10:10:00Z

The creation time.

gmt_modified

DATE

No

2018-10-10T10:10:00Z

The modification time.

group_name

STRING

No

test_group

The group name.

operator

STRING

No

scott

The creator.

tenant_id

STRING

No

TSCPDICNT

The tenant ID.

workspace_id

STRING

No

default

The workspace ID.

ApiGroupQueryVO

Name

Type

Required

Example

Description

page_info

PageInfo

No

-

Paging information.

query

ApiGroupVO

No

-

The query.

ApiGroupPagedListVO

Name

Type

Required

Example

Description

list

ARRAY[ApiGroupVO]

No

-

The data on the current page.

page_info

PageInfo

No

-

Paging information.

RouterInfoVO

Name

Type

Required

Example

Description

api_count

NUMBER

No

-

The number of APIs.

can_delete

BOOLEAN

No

true, false

Can I delete it?

gmt_create

DATE

No

2018-10-10T10:10:00Z

The creation time.

gmt_modified

DATE

No

2018-10-10T10:10:00Z

The modification time.

operator

STRING

No

scott

The operator.

router_configs

ARRAY[RouterConfigVO]

No

-

routerConfigs

router_id

STRING

No

8Amfi67dmE9wpY46

router_name

STRING

No

router_name1

routerName

router_type

STRING

No

PATH / HEADER / WEIGHT

routerType

upstream_protocol

STRING

No

HTTP / SOFA / SOFA_VPC

The backend protocol type.

RouterInfoQueryVO

Name

Type

Required

Example

Description

page_info

PageInfo

No

-

Paging information.

query

RouterInfoVO

No

-

The query.

RouterInfoPagedListVO

Name

Type

Required

Example

Description

list

ARRAY[RouterInfoVO]

No

-

List

page_info

PageInfo

No

-

Paging information.

RouterConfigVO

Name

Type

Required

Example

Description

arg_key

STRING

No

arg_key1

argKey

arg_value

STRING

No

arg_value1

argValue

match_type

STRING

No

IN /EQUAL

The matching method.

router_type

STRING

No

PATH / HEADER / WEIGHT

router_type

system_cluster

SystemClusterVO

No

-

The system cluster.

sys_id

STRING

No

z8qkEoU6QlfNQlsQ

sys_id

weight

NUMBER

No

-

The weight.

ContactInfoVO

Name

Type

Required

Example

Description

auth_app_info_id

STRING

No

a0VIPBXUI4rc25gR

The authorized application ID.

company

STRING

No

antfinancial

The company name.

contact_id

STRING

No

a0VIPBcUI4rd25gR

The contact ID.

gmt_create

DATE

No

2018-10-10T10:10:00Z

The creation time.

gmt_modified

DATE

No

2018-10-10T10:10:00Z

The update time.

mail

STRING

No

kelly.cq@antxxx.com

The email address.

name

STRING

No

kelly

The contact name.

tel

STRING

No

0571-812xxxxx

The telephone number.

tenant_id

STRING

No

TSCPDICNT

The tenant ID.

workspace_id

STRING

No

default

The workspace ID.

ContactInfoQueryVO

Name

Type

Required

Example

Description

page_info

PageInfo

No

-

Paging information.

query

ContactInfoVO

No

-

The query.

ContactInfoPagedListVO

Name

Type

Required

Example

Description

list

ARRAY[ContactInfoVO]

No

-

The list of contacts.

page_info

PageInfo

No

-

Paging information.

PageInfo

Name

Type

Required

Example

Description

order_infos

ARRAY[OrderInfo]

No

-

Sorting information.

page_index

NUMBER

No

2

Current page

page_size

NUMBER

No

10

The number of records per page.

total

NUMBER

No

10

Total

EncryptConfigVO

Name

Type

Required

Example

Description

app_id

STRING

No

app1

app_id

encrypt_type

STRING

No

NONE / RSA / ECC / SM

The encryption algorithm.

key_pair

STRING

No

keypair1

Key pair

private_key

STRING

No

key1

private_key

pub_key

STRING

No

key1

pub_key

workspace_id

STRING

No

default

The workspace ID.

OrderInfo

Name

Type

Required

Example

Description

key

STRING

Yes

groupName

The field to sort by.

order

STRING

Yes

asc / desc

In ascending or descending order

ActionResult

Name

Type

Required

Example

Description

code

STRING

No

code1

The error code.

error_message

STRING

No

error_message1

The error message.

id

STRING

No

id1

ID

success

BOOLEAN

No

true, false

Indicates whether the attachment was successful.

BatchActionResult

Name

Type

Required

Example

Description

failed_count

NUMBER

No

5

failed_count

results

ARRAY[ActionResult]

No

-

The results of the batch attachment.

success_count

NUMBER

No

5

success_count

total_count

NUMBER

No

10

total_count

CorsInfoVO

Name

Type

Required

Example

Description

allow_credentials

BOOLEAN

No

true, false

Indicates whether to allow sending cookies.

allow_headers

ARRAY[STRING]

No

-

The allowed request headers.

allow_methods

ARRAY[STRING]

No

-

The allowed HTTP methods.

allow_origins

ARRAY[STRING]

No

-

The allowed origins.

api_count

NUMBER

No

2

The number of APIs.

cors_id

STRING

No

cors_id1

The CORS ID.

cors_name

STRING

No

cors_name1

The CORS name.

cors_scop

STRING

No

WORKSPACE/API

The CORS scope.

cors_status

STRING

No

CLOSED/OPENED

The CORS status.

expose_headers

ARRAY[STRING]

No

-

The allowed exposed response headers.

gmt_create

DATE

No

2018-10-10T10:10:00Z

The creation time.

gmt_modified

DATE

No

2018-10-10T10:10:00Z

The update time.

max_age

NUMBER

No

10

The validity period of the preflight request.

operator

STRING

No

scott

The creator.

tenant_id

STRING

No

TSCPDICNT

The tenant ID.

workspace_id

STRING

No

default

The workspace ID.

CorsInfoQueryVO

Name

Type

Required

Example

Description

page_info

PageInfo

No

-

Paging information.

query

CorsInfoVO

No

-

The query.

CorsInfoPagedListVO

Name

Type

Required

Example

Description

list

ARRAY[CorsInfoVO]

No

-

The list of CORS configurations.

page_info

PageInfo

No

-

Paging information.

ApiCacheVO

Name

Type

Required

Example

Description

cache_keys

ARRAY[ApiCacheKeyVO]

No

-

The cache keys.

need_cache

BOOLEAN

No

true, false

Indicates whether caching is needed.

ttl

NUMBER

No

10000

TTL

ApiCacheKeyVO

Name

Type

Required

Example

Description

key

STRING

No

key1

The cache key.

location

STRING

No

HEADER/QUERY/BODY

The cache location.

LimitConfigVO

Name

Type

Required

Example

Description

limit

NUMBER

No

-

The rate limit threshold.

limit_rsp_type

STRING

No

DEFAULT/MSG

Response type limit

need_limit

BOOLEAN

No

true, false

Are there any limits?

rsp_msg

STRING

No

rsp_msg1

The response message.

ApiTestReqVO

Name

Type

Required

Example

Description

api_id

STRING

No

api_id1

The API ID.

app_id

STRING

No

app_id1

The application ID.

auth_app_info_id

STRING

No

auth_app_info_id1

The authorized application ID.

params

ARRAY[ApiTestParamVO]

No

-

The API debugging parameters.

payload

STRING

No

payload1

Payload

tenant_id

STRING

No

tenant_id

The tenant ID.

workspace_id

STRING

No

default

The workspace ID.

ApiTestRspVO

Name

Type

Required

Example

Description

code

STRING

No

code1

code

cost

NUMBER

No

1000

Cost

headers

ARRAY[ApiTestParamVO]

No

-

The headers.

payload

STRING

No

payload1

payload

size

NUMBER

No

1000

The size.

ApiTestParamVO

Name

Type

Required

Example

Description

key

STRING

No

key1

Key-value

location

STRING

No

HEADER/QUERY

The location.

value

STRING

No

value1

The value.

MonitorData

Name

Type

Required

Example

Description

timestamp

NUMBER

No

-

The timestamp.

value

NUMBER

No

-

The value.

MonitoringRequest

Name

Type

Required

Example

Description

api_id

STRING

No

h4ZWfWe9anCJn4Tye3tPMiGJZJ2PeGWq

The API ID.

app_id

STRING

No

Oo2llCf0MkkhGtgL

The application ID.

code

STRING

No

code1

The code.

end_time

NUMBER

No

-

The end time.

start_time

NUMBER

No

-

The start time.

MonitoringAggregationVO

Name

Type

Required

Example

Description

byte_in

ARRAY[MonitorData]

No

-

Byte data import

byte_out

ARRAY[MonitorData]

No

-

Exporting bytes

err_code

ARRAY[MonitorData]

No

-

The error code.

err_rate

ARRAY[MonitorData]

No

-

The error rate.

invoke_num

ARRAY[MonitorData]

No

-

Invocation value

qps

ARRAY[MonitorData]

No

-

The QPS value.

rt

ARRAY[MonitorData]

No

-

The RT value.