Help Center/ ROMA Connect/ API Reference/ Service Integration APIs/ Custom Backend Management/ Verifying the Definition of a Custom Backend API
Updated on 2025-10-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Verifying the Definition of a Custom Backend API

Function

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

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

POST /v2/{project_id}/apic/instances/{instance_id}/livedata-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

type

Yes

String

Verification type.

  • path: path type

  • name: name type

ld_api_name

No

String

Name of the custom backend API.

This parameter is mandatory when type is set to name.

ld_api_method

No

String

Request method of the custom backend API.

This parameter is mandatory when type is set to path.

ld_api_path

No

String

Access address of the custom backend API.

This parameter is mandatory when type is set to path.

roma_app_id

No

String

Integration application ID.

This parameter is mandatory when you need to check whether backend API definitions are duplicate in an integration application.

Response Parameters

Status code: 204

No Content

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

Check whether the name of a specified custom backend already exists.

{
  "type" : "name",
  "ld_api_name" : "ld_api_demo"
}

Example Responses

Status code: 400

Bad Request

{
  "error_code" : "APIG.3215",
  "error_msg" : "The livedata API name already exists"
}

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.