Querying Applications

Function

This API is used to query applications that meet all the given conditions.

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

GET /v2/{project_id}/instances/{instance_id}/apps

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
instance_id	Yes	String	Instance ID.
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see "Appendix" > "Obtaining a Project ID" in the API Reference.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Offset, which is greater than or equal to 0.
limit	No	Integer	Number of items displayed on each page.
favorite	No	Boolean	Query scope related to favorited applications. If this parameter is not specified, all applications on which the caller has permissions are queried. If this parameter is set to true, favorited applications are queried. If this parameter is set to false, unfavorited applications are queried.
auth_role	No	String	Permissions of applications to query.
name	No	String	Application name. Fuzzy match by application name is supported.
key	No	String	Application key (fuzzy match).
owner	No	Boolean	Query scope related to accessible applications. If this parameter is not specified, all applications on which the caller has permissions are queried. If this parameter is set to true, applications created by the caller are queried. If this parameter is set to false, applications that are not created by the caller and on which the caller has permissions are queried, for example, applications shared by other users.
user_name	No	String	Name of the user who has permissions on applications to query. This parameter is used to filter out applications on which the specified user has permissions from all the applications on which the caller has permissions.

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
total	Integer	Total number of applications.
size	Integer	Number of applications displayed on the current page.
apps	Array of ServerAppInfo objects	Application information.

**Table 5** ServerAppInfo
Parameter	Type	Description
id	String	Application ID.
name	String	Application name. Characters allowed: letters, digits, hyphens (-), underscores (_), periods (.), spaces, and parentheses. Constraints: The value must be unique in an instance.
remark	String	Application description.
roles	Array of strings	Application permissions. read: permission to read resources of an application, including API debugging. This permission must be included. access: permission to access resources of an application. delete: permission to delete resources of an application. modify: permission to modify resources of an application, including API release and removal. admin: all permissions on an application and its resources. When only the user admin is provided, all other permissions are automatically applied. The read permission is automatically applied when it is not provided.
create_time	String	Creation time.
update_time	String	Update time.
created_user	created_user object	Information about the user who created the application.
last_updated_user	last_updated_user object	Information about the user who last updated the application.
owner	Boolean	Whether the user is the owner of the application.
key	String	Application authentication access key. If no key is specified, a random value is generated. Characters allowed: letters, digits, hyphens (-), underscores (_), at signs (@), and periods (.); The value must start with a letter or digit. Constraints: The value must be unique in an instance.
favorite	Boolean	Whether to favorite the application. Favorited applications will be displayed preferentially in the list.

**Table 6** created_user
Parameter	Type	Description
user_id	String	ID of the user who created the application.
user_name	String	Name of the user who created the application.

**Table 7** last_updated_user
Parameter	Type	Description
user_id	String	ID of the user who last updated the application.
user_name	String	Name of the user who last updated the application.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_details	String	Error information.
request_id	String	Request ID.

Example Requests

None

Example Responses

Status code: 200

{
  "total" : 0,
  "size" : 0,
  "apps" : [ {
    "id" : "b2e6b145-4f3f-4a80-aa45-f4b8029f95a3",
    "name" : "AppName",
    "remark" : "example",
    "roles" : [ "admin" ],
    "create_time" : "2019-12-06T06:49:04Z",
    "update_time" : "2019-12-06T06:49:04Z",
    "created_user" : {
      "user_id" : "string",
      "user_name" : "string"
    },
    "last_updated_user" : {
      "user_id" : "string",
      "user_name" : "string"
    },
    "owner" : true,
    "key" : "TEI***8UM",
    "favorite" : true
  } ]
}

Status code: 403

Forbidden

{
  "error_code" : "ROMA.00000101",
  "error_msg" : "error summary",
  "error_details" : "some error details here",
  "request_id" : "13760c1fe8655e61209b75665e9bef43"
}