Querying an API List

Function

This API is used to query the API list.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/service/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 Project ID and Account ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Query start coordinate, that is, skipping the first X records. The value can only be 0 or an integer multiple of limit. If the requirement is not met, the value is rounded down.
limit	No	Integer	Maximum number of records that can be queried
name	No	String	Fuzzy query based on the API name.
description	No	String	Fuzzy query based on the API description.
create_user	No	String	Create a user fuzzy query based on the API.
start_time	No	String	Start time, which is accurate to second, complies with RFC3339, and uses the UTC time zone, for example, 2024-02-24T16:00:00.000Z
end_time	No	String	End time, which is accurate to second, complies with RFC3339, and uses the UTC time zone, for example, 2024-04-05T15:59:59.998Z
tags	No	Array of strings	Tag
api_type	No	String	API type Enumerated values include: API_SPECIFIC_TYPE_CONFIGURATION: configuration API API_SPECIFIC_TYPE_SCRIPT: script API API_SPECIFIC_TYPE_MYBATIS: MyBatis API API_SPECIFIC_TYPE_GROOVY: Groovy API API_SPECIFIC_TYPE_REGISTER: registered API API_SPECIFIC_TYPE_ORCHESTRATE: orchestrated API
publish_status	No	String	API publishing status Enumerated values include: PUBLISHED: published NOT_PUBLISHED: unpublished
table_name	No	String	Fuzzy query based on the database table name used by the API.
authorization_status	No	String	Authorization status. Enumerated values: NO_AUTHORIZATION_REQUIRED: no authorization required UNAUTHORIZED: unauthorized AUTHORIZED: authorized

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. This parameter is mandatory when token authentication is used. You can obtain it from the value of X-Subject-Token in the response message header returned by the "Obtaining a User Token" API of the IAM service.
workspace	Yes	String	Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID.
Dlm-Type	No	String	Specifies the version type of the data service. The value can be SHARED or EXCLUSIVE.
Content-Type	Yes	String	Type (format) of the message body. This parameter is mandatory if the message body exists. If the message body does not exist, leave this parameter blank. If the request body contains Chinese characters, use charset=utf8 to specify the Chinese character set, for example, application/json;charset=utf8.
x-return-publish-messages	No	String	Specifies whether to return the publishing information of the exclusive API.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Total number of APIs.
records	Array of ApiOverview objects	API list.

**Table 5** ApiOverview
Parameter	Type	Description
id	String	API ID.
name	String	API name
group_id	String	API group ID (shared version).
description	String	API description,
status	String	API status (DataArts DataService Shared) Enumerated values: API_STATUS_CREATED: created API_STATUS_PUBLISH_WAIT_REVIEW: waiting for review API_STATUS_PUBLISH_REJECT: rejected API_STATUS_PUBLISHED: published API_STATUS_WAITING_STOP: waiting to be stopped API_STATUS_STOPPED: stopped API_STATUS_RECOVER_WAIT_REVIEW: waiting to be recovered API_STATUS_WAITING_OFFLINE: waiting to be suspended API_STATUS_OFFLINE: suspended API_STATUS_OFFLINE_WAIT_REVIEW: waiting to be reviewed for suspension
debug_status	String	API debugging status (DataArts DataService Shared) Enumerated values: API_DEBUG_WAITING: waiting to be debugged API_DEBUG_FAILED: debugging failed API_DEBUG_SUCCESS: debugging successful
publish_messages	Array of ApiPublishDTO objects	Release information list (exclusive edition).
type	String	API type.
manager	String	API reviewer.
create_user	String	API creator.
create_time	Long	API creation time
authorization_status	String	Authorization status. Enumerated values: NO_AUTHORIZATION_REQUIRED: no authorization required UNAUTHORIZED: unauthorized AUTHORIZED: authorized

**Table 6** ApiPublishDTO
Parameter	Type	Description
id	String	Release ID.
api_id	String	API ID
instance_id	String	Cluster ID
instance_name	String	Cluster Name
api_status	String	API status (DataArts DataService Shared) Enumerated values: API_STATUS_CREATED: created API_STATUS_PUBLISH_WAIT_REVIEW: waiting for review API_STATUS_PUBLISH_REJECT: rejected API_STATUS_PUBLISHED: published API_STATUS_WAITING_STOP: waiting to be stopped API_STATUS_STOPPED: stopped API_STATUS_RECOVER_WAIT_REVIEW: waiting to be recovered API_STATUS_WAITING_OFFLINE: waiting to be suspended API_STATUS_OFFLINE: suspended API_STATUS_OFFLINE_WAIT_REVIEW: waiting to be reviewed for suspension
api_debug	String	API debugging status (DataArts DataService Shared) Enumerated values: API_DEBUG_WAITING: waiting to be debugged API_DEBUG_FAILED: debugging failed API_DEBUG_SUCCESS: debugging successful

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

Query the information about a script API created and published by the administrator.

/v1/0833a5737480d53b2f250010d01a7b88/service/apis?api_type=API_SPECIFIC_TYPE_SCRIPT&publish_status=PUBLISHED&create_user=admin&description=test

{
  "api_type" : "API_SPECIFIC_TYPE_SCRIPT",
  "publish_status" : "PUBLISHED",
  "create_user" : "admin",
  "description" : "Test"
}

Example Responses

Status code: 200

Success

{
  "total" : 1,
  "records" : [ {
    "id" : "fd0beac79418d65e3b3ed24a6e53b24b",
    "name" : "testApi",
    "create_time" : 1579162215000,
    "status" : "API_STATUS_CREATED",
    "manager" : "admin",
    "type" : "API_SPECIFIC_TYPE_REGISTER",
    "debug_status" : "API_DEBUG_WAITING",
    "description" : "api description"
  } ]
}