Help Center/ ROMA Connect/ API Reference/ Service Integration APIs/ Orchestration Rule Management/ Querying APIs to Which an Orchestration Rule Is Bound
Updated on 2025-07-18 GMT+08:00
View PDF

Querying APIs to Which an Orchestration Rule Is Bound

Function

This API is used to query the APIs to which a plug-in has been bound.

  • Query APIs bound with a specified plug-in.

  • Pagination query

  • Fuzzy query by API name

URI

GET /v2/{project_id}/apic/instances/{instance_id}/orchestrations/{orchestration_id}/attached-apis

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.

orchestration_id

Yes

String

Orchestration rule 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.

limit

No

Integer

Number of items displayed on each page.

api_name

No

String

API name.

api_id

No

String

API ID.

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.

apis

Array of OrchestrationApiInfo objects

List of APIs to which an orchestration rule has been bound.
Table 5 OrchestrationApiInfo

Parameter

Type

Description

api_id

String

API ID.

api_name

String

API name.

Start with a letter or digit with 3 to 255 characters. Only letters, digits, and these special characters are allowed: -_./:()

req_method

String

Request method.

req_uri

String

Request address. It can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks (*), slashes (/), percent signs (%), hyphens (-), underscores (), and periods (.), are allowed. It can contain a maximum of 512 characters and must comply with URI specifications. Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores () are allowed.

NOTE:

The address must comply with the URI specifications.

auth_type

String

API authentication mode. Options:

  • NONE: no authentication

  • APP: App authentication

  • IAM: IAM authentication

  • AUTHORIZER: Custom authentication

match_mode

String

API matching mode. Options:

  • SWA: Prefix match

  • NORMAL (default): Exact match

group_id

String

ID of the API group to which an API belongs.

group_name

String

Name of the API group to which the API belongs.

attached_time

String

Binding time.

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" : 1,
  "size" : 1,
  "apis" : [ {
    "api_id" : "8aa097b00e9843efabc9c593d11b769d",
    "api_name" : "api_demo",
    "req_method" : "GET",
    "req_uri" : "/test",
    "auth_type" : "IAM",
    "match_mode" : "NORMAL",
    "group_id" : "b9be707660c5406394f8973e087bae20",
    "group_name" : "group_demo",
    "attached_time" : "2023-07-02T12:31:23.353Z"
  } ]
}

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-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.