Help Center> ROMA Connect> API Reference> APIC APIs> Configuration Management> Querying Resource Configurations of an Instance
View PDF

Querying Resource Configurations of an Instance

Function

This API is used to query the resource configurations and usage of an instance.

URI

GET /v2/{project_id}/apic/instances/{instance_id}/project/configs

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

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.

configs

Array of Config objects

Quota list.
Table 5 Config

Parameter

Type

Description

config_id

String

Quota ID.

config_name

String

Quota name.

config_value

String

Quota value.

It indicates the value of the quota for the current instance.

config_time

String

Time when the quota was created.

remark

String

Description about the quota

  • API_NUM_LIMIT: Maximum number of APIs you can create

  • APP_NUM_LIMIT: Maximum number of apps you can create

  • APIGROUP_NUM_LIMIT: Maximum number of API groups you can create

  • ENVIRONMENT_NUM_LIMIT: Maximum number of environments you can create

  • VARIABLE_NUM_LIMIT: Maximum number of environment variables you can create for an API group

  • SIGN_NUM_LIMIT: Maximum number of signature keys you can create

  • THROTTLE_NUM_LIMIT: Maximum number of request throttling policies you can create

  • APIGROUP_DOMAIN_NUM_LIMIT: Maximum number of custom domain names you can bind to an API group

  • API_VERSION_NUM_LIMIT: Maximum number of versions you can retain for an API

  • VPC_NUM_LIMIT: Maximum number of VPC channels you can create

  • VPC_INSTANCE_NUM_LIMIT: Maximum number of cloud servers you can associate with a VPC channel

  • API_PARAM_NUM_LIMIT: Maximum number of parameters you can configure for an API

  • API_USER_CALL_LIMIT: Maximum number of times an API can be called within a specific period

  • ACL_NUM_LIMIT: Maximum number of access control policies you can create

  • APP_THROTTLE_LIMIT: Maximum number of excluded apps allowed for a request throttling policy

  • USER_THROTTLE_LIMIT: Maximum number of excluded tenants allowed for a request throttling policy

  • API_NUM_LIMIT_PER_GROUP: Maximum number of APIs you can create for an API group

  • API_POLICY_NUM_LIMIT: Maximum number of policy backends you can configure for an API

  • API_CONDITION_NUM_LIMIT: Maximum number of conditions you can configure for a policy backend

  • SL_DOMAIN_CALL_LIMIT: Maximum number of requests that can be sent to a subdomain name within a specific period

  • ELB_SWITCH: Whether to enable ELB channels

  • AUTHORIZER_NUM_LIMIT: Maximum number of custom authorizers you can create

  • AUTHORIZER_IDENTITY_NUM_LIMIT: Maximum number of identity sources you can configure for a custom authorizer

  • APP_CODE_NUM_LIMIT: Maximum number of AppCodes you can create for an app

  • REGION_MANAGER_WHITELIST_SERVICES: Whitelist of services that are not verified by the region manager

  • API_SWAGGER_NUM_LIMIT: Maximum number of Swagger files you can bind to an API group

  • API_TAG_NUM_LIMIT: Maximum number of tags you can configure for an API

  • LTS_SWITCH: Whether to enable LTS log reporting

  • APP_KEY_SECRET_SWITCH: Whether to enable AppKey and AppSecret customization. 1: enable; 2: disable.

  • RESPONSE_NUM_LIMIT: Maximum number of responses you can create for an API group

  • CONFIG_NUM_LIMIT_PER_APP: Maximum number of configuration items you can set for an app

  • BACKEND_TOKEN_ALLOW_SWITCH: Whether to allow tenants to transparently transmit tokens to the backend. 1: allow; 2: disallow.

  • APP_TOKEN_SWITCH: Whether to enable AppTokens

  • API_DESIGNER_SWITCH: Whether to enable the API designer. 1: enable; 2: disable.

  • APP_API_KEY_SWITCH: Whether to enable APP_API_KEY authentication

  • APP_BASIC_SWITCH: Whether to enable APP_BASIC authentication

  • APP_JWT_SWITCH: Whether to enable APP_JWT authentication

  • APP_ROUTE_SWITCH: Whether to enable app routes

  • PUBLIC_KEY_SWITCH: Whether to enable PUBLIK_KEY backend authentication

  • APP_SECRET_SWITCH: Whether to enable APP_SECRET authentication

  • CASCADE_SWITCH: Whether to enable cascaded gateways

  • IS_INIT_API_PATH_HASH: Whether API PATH HASH has been updated

  • APP_QUOTA_NUM_LIMIT: Maximum number of clients you can create

  • IS_INIT_API_VERSION: Whether the API VERSION CANONICAL PATH has been updated

  • PLUGIN_NUM_LIMIT: Maximum number of plug-ins you can create

  • APICLIENT_FIRST_USE_X_HW_ID_SWITCH: Whether ApiClient preferentially uses x-hw-id to verify permissions

  • API_TASK_NUM_LIMIT: Maximum number of scheduled API tasks you can create]

  • THROTTLE_LOCAL_SWITCH: Whether to enable the local flow control mode

  • API_TASK_SWITCH: Whether a tenant supports scheduled tasks

  • SET_HEADERS_NUM_LIMIT_PER_PLUGIN: Maximum number of HTTP headers you can create using a plug-in

  • LUA_SCRIPT_SWITCH: Whether a tenant can use the lua_script plug-in

  • LUA_SCRIPT_NUM_LIMIT: Maximum number of lua_script plug-ins you can create for each instance

  • SM_DICT_NUM_LIMIT: Maximum number of data dictionaries you can create for each instance

  • BM_VPC_INSTANCE_GROUP_NUM_LIMIT: Maximum number of backend server groups of the VPC channel you can create for each instance (tag:hws)

used

Long

Used quota of the instance.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

None

Example Responses

Status code: 200

OK

{
  "total" : 43,
  "size" : 2,
  "configs" : [ {
    "config_id" : "9",
    "config_name" : "API_VERSION_NUM_LIMIT",
    "config_value" : "10",
    "config_time" : "2019-02-12T19:42:19.914989Z",
    "remark" : "xxx",
    "used" : 0
  }, {
    "config_id" : "8",
    "config_name" : "APIGROUP_DOMAIN_NUM_LIMIT",
    "config_value" : "5",
    "config_time" : "2019-02-12T19:42:19.914989Z",
    "remark" : "xxx",
    "used" : 0
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:instance_id. 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-9892951c620e"
}

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: Configuration Management