Querying Apps Bound to an API

Function

This API is used to query the apps that have been authorized to an API.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/service/authorize/apis/{api_id}

**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.
api_id	Yes	String	API ID

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Query offset, that is, X data records are skipped. The value must be 0 or an integer multiple of limit. If the value does not meet the requirements, it will be rounded down.
limit	No	Integer	Maximum number of records that can be queried

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.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Total number of apps that meet the search criteria.
records	Array of RecordForGetAuthApp objects	App list returned this time.

**Table 5** RecordForGetAuthApp
Parameter	Type	Description
app_id	String	App ID
app_name	String	Application name.
instance_id	String	Cluster instance ID.
instance_name	String	Name of a cluster instance.
api_using_time	Long	Expiry time of using the API,
approval_time	Long	Authorization time,
relationship_type	String	Binding relationship Enumerated values: LINK_WAITING_CHECK: waiting to be reviewed LINKED: bound OFFLINE_WAITING_CHECK: waiting to be suspended RENEW_WAITING_CHECK**: waiting to be renewed
static_params	Array of StaticParam objects	List of static parameters.

**Table 6** StaticParam
Parameter	Type	Description
para_name	String	Name of a static parameter.
para_value	String	Static parameter value.

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 apps that have been authorized to an API.

/v1/0833a5737480d53b2f250010d01a7b88/service/authorize/apis/

Example Responses

Status code: 200

The query is successful, and the list of apps authorized to the API is displayed.

{
  "total" : 1,
  "records" : [ {
    "app_id" : "908489209a320df61607355c57c82882",
    "app_name" : "app_demo",
    "api_using_time" : 1580452617000,
    "approval_time" : 1578897421000
  } ]
}