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

Querying API Groups

Function

This API is used to query the API group list.

You can query all API groups in your account as a tenant, or query API groups of all tenants using an administrator account.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups

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.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Long

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

Default: 0

limit

No

Integer

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

Minimum: 1

Maximum: 500

Default: 20

id

No

String

API group ID.

name

No

String

API group name.

precise_search

No

String

Parameter name for exact matching. Only API group names are supported.

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

size

Integer

Length of the returned resource list.

total

Long

Number of resources that match the query conditions.

groups

Array of ApiGroupInfo objects

API groups.
Table 5 ApiGroupInfo

Parameter

Type

Description

id

String

ID.

name

String

API group name.

status

Integer

Status.

  • 1: valid

Enumeration values:

  • 1

sl_domain

String

Subdomain name that APIG automatically allocates to the API group.

register_time

String

Creation time.

update_time

String

Last modification time.

on_sell_status

Integer

Indicates whether the API group has been listed on KooGallery.

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

Not supported currently.

url_domains

Array of UrlDomain objects

Independent domain names bound to the API group.

sl_domains

Array of strings

Automatically allocated subdomain names.

remark

String

Description.

call_limits

Integer

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

Currently, this parameter is not supported.

time_interval

Integer

Period of time for limiting the number of API calls.

Currently, this parameter is not supported.

time_unit

String

Time unit for limiting the number of API calls.

Currently, this parameter is not supported.

is_default

Integer

Indicates whether the API group is the default group.

version

String

Group version.

  • V1: global group
  • V2: application-level group

The default value is V1. This parameter is not supported currently.

roma_app_id

String

ID of the integration application to which the API group belongs.

This parameter is required when the group version is V2.

Currently, this parameter is not supported.

roma_app_name

String

Name of the integration application to which the API group belongs.

Currently, this parameter is not supported.
Table 6 UrlDomain

Parameter

Type

Description

id

String

Domain ID.

domain

String

Domain name.

cname_status

Integer

CNAME resolution status of the domain name.

  • 1: not resolved
  • 2: resolving
  • 3: resolved
  • 4: resolution failed

ssl_id

String

SSL certificate ID.

ssl_name

String

SSL certificate name.

min_ssl_version

String

Minimum SSL version. TLS 1.1 and TLS 1.2 are supported.

Default: TLSv1.1

Enumeration values:

  • TLSv1.1
  • TLSv1.2

verified_client_certificate_enabled

Boolean

Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist.

Default: false

is_has_trusted_root_ca

Boolean

Whether a trusted root certificate (CA) exists. The value is true if trusted_root_ca exists in the bound certificate.

Default: false

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

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

{
  "total" : 2,
  "size" : 2,
  "groups" : [ {
    "update_time" : "2020-07-31T06:55:55Z",
    "name" : "api_group_001",
    "on_sell_status" : 2,
    "remark" : "API group 1",
    "sl_domains" : [ "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com", "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.cn" ],
    "sl_domain" : "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com",
    "id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
    "register_time" : "2020-07-31T06:55:55Z",
    "status" : 1,
    "is_default" : 2
  }, {
    "update_time" : "2020-06-24T15:29:42.421926Z",
    "name" : "api_group_002",
    "on_sell_status" : 2,
    "remark" : "API group 2",
    "sl_domain" : "02a8ab3cb2784de5a096852829671ae7.apic.****.com",
    "sl_domains" : [ "02a8ab3cb2784de5a096852829671ae7.apic.****.com", "02a8ab3cb2784de5a096852829671ae7.apic.****.cn" ],
    "id" : "02a8ab3cb2784de5a096852829671ae7",
    "register_time" : "2020-06-24T15:29:42.421926Z",
    "status" : 1,
    "is_default" : 2
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation"
}

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: 500

Internal Server Error

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

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: API Group Management