Help Center> API Gateway> API Reference> Dedicated Gateway APIs (V1) (To Be Deprecated)> API Group Management> Querying the API Group List
View PDF

Querying the API Group List

Function

This API is used to query an API group list.

If the operation is performed by a tenant, all groups of the tenant are queried. If the operation is performed by an administrator, the groups of all tenants are queried.

URI

The following table lists the HTTP/HTTPS request method and URI of the API.

Table 1 HTTP/HTTPS request method and URI

Request Method

URI

GET

/v1/{project_id}/apigw/instances/{instance_id}/api-groups[?page_size, page_no, id, name]
  • A combination of different query conditions can be added at the end of the URI by using question marks (?) and ampersands (&).
  • Query conditions include: id, name, page_size, and page_no.

The following table lists the parameters in the URI.

Table 2 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which can be obtained by the administrator on the My Credentials page.

instance_id

Yes

String

Instance ID, which can be obtained from the dedicated gateway information on the API Gateway console.

id

No

String

API group ID

name

No

String

API group name

page_size

No

Integer

Number of records displayed on each page. The default value is 20.

page_no

No

Integer

Page number. The default value is 1.

precise_search

No

String

Parameter name (name) for exact matching

Request

N/A

Response

Table 3 Parameter description

Parameter

Type

Description

total

Integer

Number of API groups that match the query conditions

size

Integer

Length of the returned API group list

groups

Dictionary

API group list
Table 4 API group parameter description

Parameter

Type

Description

id

String

API group ID

name

String

API group name

status

Integer

Status of the API group

sl_domain

String

Subdomain name that API Gateway automatically allocates to the API group

register_time

Timestamp

Time when the API group is created

update_time

Timestamp

Time when the API group was last modified

remark

String

Description of the API group

on_sell_status

Integer

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

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

call_limits

Integer

Total number of times all APIs in the API group can be accessed. Set this parameter while considering the payload capacity of the backend service. By default, there is no limit on the number of API calls.

time_interval

Integer

Period of time for limiting the number of API calls

time_unit

String

Time unit for limiting the number of API calls

url_domains

Dictionary

List of independent domain names bound to the API group

Example response:

{
	"total": 2,
	"size": 2,
	"groups": [{
		"id": "02a8ab3c-b278-4de5-a096-852829671ae7",
		"name": "api_group_002",
		"status": 1,
		"sl_domain": "19e62eca-43d9-4ce2-a478-b3f48e67fb91.apigw.example.com",
		"remark": "API group 002",
		"register_time": "2017-12-28T11:57:35Z",
		"update_time": "2017-12-28T11:57:35Z",
		"on_sell_status": 2
	},
	{
		"id": "73c58022-f20d-495a-a188-85d718647f09",
		"name": "api_group_001",
		"status": 1,
		"sl_domain": "c4c230d1-a8f2-4816-b9df-09ac5989180c.apigw.example.com",
		"remark": "API group 001",
		"register_time": "2017-12-28T11:57:27Z",
		"update_time": "2017-12-28T11:57:27Z",
		"on_sell_status": 2
	}]
}

Status Codes

Table 5 Status codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

500

Server Internal Error
Parent topic: API Group Management