Updated on 2023-08-22 GMT+08:00

Querying the application list.

Function

This API is used to query the application list.

URI

GET /v1/apm2/openapi/cmdb/business/get-business-list

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token obtained from IAM.

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

business_nodes

Array of BusinessNodeModel objects

Data structure used to query an application.

Table 3 BusinessNodeModel

Parameter

Type

Description

default

Boolean

Default application.

display_name

String

Display name of an application.

eps_id

String

Enterprise project ID.

gmt_create

String

Creation time.

gmt_modify

String

Update time.

id

Long

Application ID.

inner_domain_id

Integer

Internal tenant ID.

is_default

Boolean

Whether an application is the default application.

name

String

Application name.

Example Requests

Obtain the list of applications on which you have permission. No input parameter is required.

/v1/apm2/openapi/cmdb/business/get-business-list

Example Responses

Status code: 200

OK: The request is successful.

{
  "business_nodes" : [ {
    "default" : true,
    "id" : 2,
    "gmt_create" : null,
    "gmt_modify" : null,
    "name" : "apm2",
    "display_name" : "apm2",
    "is_default" : true,
    "inner_domain_id" : 1,
    "eps_id" : "**********"
  } ]
}

Status Codes

Status Code

Description

200

OK: The request is successful.

401

Unauthorized: No permissions.

403

Forbidden: Access forbidden.

404

Not Found: The requested resource is not found.

Error Codes

See Error Codes.