Help Center/ ROMA Connect/ API Reference/ Service Integration APIs/ API Import and Export/ Exporting APIs
Updated on 2025-10-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Exporting APIs

Function

This API is used to export API definition information in an API group. The exported file content complies with the Swagger standard.

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}/openapi/export

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

oas_version

No

String

Exported OpenAPI version.

2.0 (default): Swagger 2.0

3.0: OpenAPI 3.0

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

Parameter

Mandatory

Type

Description

env_id

Yes

String

ID of the environment in which the API group was published.

group_id

Yes

String

API group ID.

define

No

String

Definition scope of the export API:

  • spec: basic definition, including only the API frontend definition.

  • proxy: full definition, including the API frontend and backend definitions.

  • all: extended definition, including the API frontend and backend definitions, as well as extended definitions such as request throttle, access control, and customized authentication.

  • dev: development definition, including the frontend and backend definitions of APIs that are not published.

type

No

String

Format of the exported API definition.

version

No

String

Version of the exported API definition. The default value is the current time.

apis

No

Array of strings

List of exported API IDs.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

-

File

Exported API file.

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

Export APIs in a specified API group with definition scope as all.

{
  "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
  "define" : "all"
}

Example Responses

Status code: 400

Bad Request

{
  "error_code" : "APIG.2001",
  "error_msg" : "The request parameters must be specified,parameterName:env_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.3001",
  "error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 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: API Import and Export