Help Center> API Gateway> API Reference> Dedicated Gateway APIs (V1) (To Be Deprecated)> API Group Management> Querying Details of an API Group
View PDF

Querying Details of an API Group

Function

This API is used to query the details of an API group.

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/{id}

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

Yes

String

API group ID

Request

N/A

Response

Table 3 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 request throttling policy

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

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
Table 4 Parameter description of url_domains

Parameter

Type

Description

id

String

Domain ID

domain

String

Domain name

cname_status

Integer

CNAME resolution status of the domain name, which can be:

  • 1: not resolved
  • 2: in progress
  • 3: successful
  • 4: failed

ssl_id

String

SSL certificate ID

ssl_name

String

SSL certificate name

Example response:

{
	"id": "7efb2b91-155a-4f6a-9f45-c5c95a6e4950",
	"name": "api_group_001",
	"status": 1,
	"sl_domain": "0e91b83b-0774-4e8e-b187-2d695ed4743b.apigw.example.com",
	"remark": "API group 001",
	"register_time": "2017-12-28T11:44:53Z",
	"update_time": "2017-12-28T11:49:01.048601Z",
	"call_limits": 1000,
	"time_interval": 1,
	"time_unit": "SECOND",
	"on_sell_status": 2
}

Status Codes

Table 5 Status codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Internal Error
Parent topic: API Group Management