Help Center/ ROMA Connect/ API Reference/ Service Integration APIs/ Client Configuration/ Querying Apps
Updated on 2023-06-29 GMT+08:00
View PDF
Share

Querying Apps

Function

This API is used to query apps.

URI

GET /v2/{project_id}/apic/instances/{instance_id}/apps

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

App ID.

name

No

String

App name.

status

No

Integer

App status.

app_key

No

String

AppKey.

precise_search

No

String

Parameter name for exact matching. If multiple parameters need to support exact match, separate them with commas (,).

Currently, only name is supported.

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.

apps

Array of AppInfoWithBindNum objects

Applications.
Table 5 AppInfoWithBindNum

Parameter

Type

Description

id

String

ID.

name

String

Name.

remark

String

Description.

creator

String

Creator of an application:

  • USER: created by a user

  • MARKET: allocated by KooGallery

MARKET is not supported yet.

update_time

String

Creator of an application:

  • USER: created by a user

  • MARKET: allocated by KooGallery

MARKET is not supported yet.

app_key

String

Update time.

app_secret

String

Key.

register_time

String

Registration time.

status

Integer

Status:

  • 1: Valid

app_type

String

Application type:

  • apig: existing APIG application (not recommended)

  • roma: ROMA integration application

roma_app_type

String

ROMA application type.

  • subscription

  • integration

bind_num

Integer

Number of APIs bound.

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" : 2,
  "size" : 2,
  "apps" : [ {
    "id" : "356de8eb7a8742168586e5daf5339965",
    "name" : "app_demo",
    "remark" : "app example",
    "creator" : "USER",
    "update_time" : "2020-08-03T13:09:13Z",
    "app_key" : "ee8f878c252747028f07eb116c2cd91b",
    "app_secret" : "416b6b2a1d394111b9bc1df0e6842ab8",
    "register_time" : "2020-08-03T13:09:13Z",
    "status" : 1,
    "app_type" : "roma",
    "roma_app_type" : "integration",
    "bind_num" : 0
  }, {
    "id" : "9ed8b7fe84224de681e7d7a5587e76dc",
    "name" : "app_001",
    "remark" : "remark",
    "creator" : "USER",
    "update_time" : "2020-05-27T10:38:03.133586Z",
    "app_key" : "840b8b5b1efc4ec686639759c2c584da",
    "app_secret" : "0a4e7035e81e424ab4c2c571980d5c6e",
    "register_time" : "2020-03-28T11:09:06Z",
    "status" : 1,
    "app_type" : "roma",
    "roma_app_type" : "integration",
    "bind_num" : 3
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.2011",
  "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: Client Configuration