Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
Help Center/ Application Performance Management/ API Reference(2.0)/ APIs/ APM/ Searching for Components, Environments, and Agents in a Region

Searching for Components, Environments, and Agents in a Region

Function

This API is used to search for components, environments, and Agents in a region.

URI

POST /v1/apm2/openapi/apm-service/app-mgr/search

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token obtained from IAM.

x-business-id

Yes

Long

Application ID.

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

business_id

Yes

Long

Application ID.

region

Yes

String

Region name.

page

Yes

Integer

Page number.

page_size

No

Integer

Number of records on each page.

keyword

No

String

Keyword used for search.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

app_info_list

Array of AppInfo objects

Component list.

app_total_count

Integer

Total number of components.

app_info_map

Map<String,AppInfo>

Mappings between component names and details.

Table 4 AppInfo

Parameter

Type

Description

env_name

String

Environment name.

env_id

Long

Environment ID.

app_name

String

Component name.

app_id

Long

Component ID.

online_count

Integer

Number of online Agents.

disable_count

Integer

Number of Agents that are manually stopped.

offline_count

Integer

Number of offline Agents.

data_source

String

Data source.

Example Requests

Search for the Agents whose region ID is and application ID is 6, with the page number set to 1 and page size set to 10.

/v1/apm2/openapi/apm-service/app-mgr/search

{
  "business_id" : 6,
  "region" : "",
  "keyword" : "apm",
  "page" : 1,
  "page_size" : 10
}

Example Responses

Status code: 200

OK: The request is successful.

{
  "app_info_list" : [ {
    "env_name" : "beta",
    "env_id" : 1,
    "app_name" : "application_name",
    "app_id" : 2,
    "online_count" : 2,
    "disable_count" : 1,
    "offline_count" : 1
  } ],
  "app_total_count" : 4,
  "app_info_map" : {
    "additionalProp1" : {
      "env_name" : "string",
      "env_id" : 0,
      "app_name" : "string",
      "app_id" : 0,
      "online_count" : 0,
      "disable_count" : 0,
      "offline_count" : 0
    },
    "additionalProp2" : {
      "env_name" : "string",
      "env_id" : 0,
      "app_name" : "string",
      "app_id" : 0,
      "online_count" : 0,
      "disable_count" : 0,
      "offline_count" : 0
    },
    "additionalProp3" : {
      "env_name" : "string",
      "env_id" : 0,
      "app_name" : "string",
      "app_id" : 0,
      "online_count" : 0,
      "disable_count" : 0,
      "offline_count" : 0
    }
  }
}

Status Codes

Status Code

Description

200

OK: The request is successful.

400

Bad Request: Semantic or parameter error.

401

Unauthorized: No permissions.

403

Forbidden: Access forbidden.

404

Not Found: The requested resource is not found.

Error Codes

See Error Codes.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback