Help Center/ ROMA Connect/ API Reference/ Service Integration APIs/ API Group Management/ Querying API Groups

Updated on 2023-06-29 GMT+08:00

View PDF

Querying API Groups

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

GET /v2/{project_id}/apic/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 the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference.
instance_id	Yes	String	Instance ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Long	Offset from which the query starts. If the offset is less than 0, the value is automatically converted to 0. Default: 0
limit	No	Integer	Number of items displayed on each page. Minimum: 1 Maximum: 500 Default: 20
id	No	String	API group ID.
name	No	String	API group name.
roma_app_id	No	String	Integration application ID.
precise_search	No	String	Parameter name for exact matching. If multiple parameters need to support exact match, separate them with commas (,). Currently, name and domain_name are supported.
domain_name	No	String	Domain name.

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
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	No.
name	String	API group name.
status	Integer	Status. 1: Valid 2: Locked
sl_domain	String	Subdomain name that the system 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 the marketplace. The value can be: 1: published 2: not published 3: being reviewed ROMA Connect is not connected to the marketplace. The default value 2 is returned.
url_domains	Array of UrlDomain objects	List of 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. Not supported yet.
time_interval	Integer	Period of time for limiting the number of API calls. Not supported yet.
time_unit	String	Time unit for limiting the number of API calls. Not supported yet.
is_default	Integer	Whether the API group is the default group.
version	String	Group version: V1: global group V2: application-level group
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.
roma_app_name	String	Name of the integration application to which the API group belongs.

**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: resolving 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
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
ssl_infos	Array of SslInfo objects	SSL certificate list. To be supported

**Table 7** SslInfo
Parameter	Type	Description
ssl_id	String	SSL certificate ID.
ssl_name	String	SSL certificate name.
algorithm_type	String	Certificate algorithm type. Options: RSA ECC SM2 To be supported
type	String	Certificate scope. Options: instance: current instance global: all instances Default: global

Status code: 400

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 401

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 403

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 404

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 500

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

None

Example Responses

Status code: 200

{
  "total" : 2,
  "size" : 2,
  "groups" : [ {
    "update_time" : "2020-07-31T06:55:55Z",
    "name" : "api_group_001",
    "on_sell_status" : 2,
    "remark" : "group1",
    "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,
    "version" : "V1"
  }, {
    "update_time" : "2020-06-24T15:29:42.421926Z",
    "name" : "api_group_002",
    "on_sell_status" : 2,
    "remark" : "group2",
    "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,
    "version" : "V1"
  } ]
}

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

Not Found

{
  "error_code" : "APIG.3030",
  "error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620ec"
}

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
404	Not Found
500	Internal Server Error

Error Codes

See Error Codes.

Parent topic: API Group Management

Previous topic: Querying Details of an API Group

Next topic: Verifying an API Group Name

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot