Help Center/ ROMA Connect/ API Reference/ Service Integration APIs/ Credential Management/ Checking Credential Details
Updated on 2025-10-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Checking Credential Details

Function

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

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

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

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.

app_id

Yes

String

Application ID

Request Parameters

Table 2 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 3 Response body parameters

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

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 8 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

{
  "creator" : "USER",
  "update_time" : "2020-08-03T13:09:13Z",
  "app_key" : "ee8f878c252747028f07eb116c2cd91b",
  "name" : "app_demo",
  "remark" : "app example",
  "id" : "356de8eb7a8742168586e5daf5339965",
  "app_secret" : "416**********ab8",
  "register_time" : "2020-08-03T13:09:13Z",
  "status" : 1,
  "app_type" : "apig"
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName: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.3002",
  "error_msg" : "App 356de8eb7a8742168586e5daf5339965 does not exist"
}

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