Help Center> ROMA Connect> API Reference> Service Integration APIs> API Management> Verifying the API Definition
Updated on 2023-06-29 GMT+08:00
View PDF

Verifying the API Definition

Function

This API is used to verify the API definition, that is, whether the API path or name already exists.

URI

POST /v2/{project_id}/apic/instances/{instance_id}/apis/check

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.

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).
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

No

String

API name.

This parameter is mandatory when type is set to name.

req_method

No

String

Request method.

This parameter is mandatory when type is set to path.

req_uri

No

String

Access address of the API.

This parameter is mandatory when type is set to path.

match_mode

No

String

Match mode of an API.

  • SWA: prefix match

  • NORMAL: exact match

This parameter is mandatory when type is set to path.

group_id

No

String

API group ID.

This parameter is mandatory when the API definition in the group is duplicate.

roma_app_id

No

String

Integration application ID.

This parameter is mandatory when the API definition in the application is duplicate.

api_id

No

String

ID of the API to be compared.

type

Yes

String

Verification type:

  • path

  • name

Response Parameters

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

{
  "type" : "name",
  "name" : "api_demo"
}

Example Responses

Status code: 400

Bad Request

{
  "error_code" : "APIG.3202",
  "error_msg" : "The API name already exists, api_name:api_demo"
}

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

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: API Management