- What's New
-
Service Overview(2.0)
- What Is APM
- Functions
- Application Scenarios
- Basic Concepts
- Edition Differences
- Permissions Management
-
Metric Overview
- Exception
- Basic Monitoring
-
Databases
- C3P0 Connection Pool Monitoring
- Cassandra Monitoring
- ClickHouse Database
- DBCP Connection Pool Monitoring
- Druid Connection Pool Monitoring
- EsRestClient Monitoring
- GaussDB Database
- HBase Monitoring
- Hikari Connection Pool Monitoring
- Jetcd Monitoring
- MongoDB Monitoring
- MySQL Database
- ObsClient Monitoring
- Oracle Database
- PostgreSQL Database
- URLs
- External Calls
- Cache
- Agent Monitoring
- Tomcat Monitoring
- Message Queues
- RPC
- IoT
- Communication Protocol
- Privacy and Sensitive Information Protection Statement
- Data Collection
- Usage Restrictions
- Billing
- JavaAgent Updates
- Billing(2.0)
- Getting Started(2.0)
-
User Guide(2.0)
- Before You Start
- Application List
- CMDB Management
-
Application Metric Monitoring
- Overview
- Application Monitoring Details
-
Application Monitoring Configuration
- Configuration Details
- Configuring the MySQL Monitoring Item
- Configuring the HttpClient Monitoring Item
- Configuring the URL Monitoring Item
- Configuring the JavaMethod Monitoring Item
- Configuring the Druid Monitoring Item
- Configuring the ApacheHttpAsyncClient Monitoring Item
- Configuring the Redis Monitoring Item
- Configuring the Jedis Monitoring Item
- Configuring the HBase Monitoring Item
- Configuring the ApacheHttpClient Monitoring Item
- Configuring the Tomcat Monitoring Item
- Configuring the EsRestClient Monitoring Item
- Configuring the WebSocket Monitoring Item
- Configuring the KafkaProducer Monitoring Item
- Configuring the Hikari Monitoring Item
- Configuring the Exception Monitoring Item
- Configuring the Thread Monitoring Item
- Configuring the GC Monitoring Item
- Configuring the JVMInfo Monitoring Item
- Configuring the JVMMonitor Monitoring Item
- Configuring ProbeInfo Monitoring Item
- Monitoring Item Views
- Instance
- Collection Status
- Component Settings
- Tracing
- Application Topology
- URL Tracing
- Resource Tag Management
- Managing Tags
- Alarm Management
- AgentAgent Management
- Configuration Management
- System Management
- Permissions Management
- Change History
-
API Reference(2.0)
- Before You Start
- API Overview
- Calling APIs
- Examples
-
APIs
-
APM
- Querying the application list.
- Querying the Master Address
- Obtaining the AK/SK
- Searching for Components, Environments, and Agents in a Region
- Saving a Monitoring Item
- Querying the Monitoring Item List
- Querying All Agents of an Application
- Enabling or Disabling Collection for an Instance
- Deleting an Agent
- REGION
- CMDB
-
VIEW
- Querying Monitoring Item Configurations
- Querying the Trace Topology
- Querying Event Details
- Querying Span Data
- Obtaining All Data of a Trace
- Obtaining the Trend Graph
- Obtaining Summary Table Data
- Obtaining the Raw Data Table
- Obtaining Raw Data Details
- Obtaining the Instance Information
- Obtaining the Monitoring Item Information
- Obtaining the Details About a Monitoring Item
- AKSK
- ALARM
- TOPOLOGY
- TRANSACTION
- TRACING
-
APM
- Permissions Policies and Supported Actions
- Appendix
- Change History
- Best Practices(2.0)
- FAQs(2.0)
- Service Overview(1.0)
- Getting Started(1.0)
- Best Practices(1.0)
- User Guide
- API Reference
- SDK Reference
-
FAQs
- General FAQs
- Consultation FAQs
-
Usage FAQs
- How Do I Obtain the AK/SK and Project ID?
- How Do I Obtain the AK/SK by Creating an Agency?
- What Can I Do If No Data Is Found or the Data Is Abnormal?
- How Do I Connect APM to Non-Web Programs?
- How Are Tracing Time Lines Drawn?
- How Does APM Collect Probe Data?
- How Does APM Collect Mesh Data?
- How Do I Calculate the Number of Used Instances?
- How Do I Connect the JBoss Server in Standalone Mode to APM?
- What Can I Do If I Cannot Search for Logs Based on Trace IDs?
- How Do I Deploy APM Probes in CCE Containers?
- What Can I Do If the SSH Tunnel Process Is Abnormal?
- How Can I Do If No Topology or Data Is Displayed After the ICAgent and Java Probes Are Installed?
- Why Are Tomcat Thread Metrics Not Displayed on the JVM Monitoring Page?
- Why Is the Allocated Memory Greater Than the Preset Maximum Memory on the JVM Monitoring Page?
- How Do I Determine Whether an ICAgent Has Been Bound in CCE?
-
More Documents
- User Guide (ME-Abu Dhabi Region)
- API Reference (ME-Abu Dhabi Region)
-
User Guide (2.0) (Kuala Lumpur Region)
-
Service Overview
- What Is APM
- Functions
- Application Scenarios
- Basic Concepts
- Edition Differences
- Permissions Management
-
Metric Overview
- Metric Overview
- Exception
- Basic Monitoring
-
Databases
- C3P0 Connection Pool Monitoring
- Cassandra Monitoring
- ClickHouse Database
- DBCP Connection Pool Monitoring
- Druid Connection Pool Monitoring
- EsRestClient Monitoring
- GaussDB Database
- HBase Monitoring
- Hikari Connection Pool Monitoring
- Jetcd Monitoring
- MongoDB Monitoring
- MySQL Database
- ObsClient Monitoring
- Oracle Database
- PostgreSQL Database
- URLs
- External Calls
- Cache
- Agent Monitoring
- Tomcat Monitoring
- Message Queues
- RPC
- IoT
- Communication Protocol
- Privacy and Sensitive Information Protection Statement
- Data Collection
- Usage Restrictions
- Getting Started
-
User Guide
- Before You Start
- Application List
- CMDB Management
-
Application Metric Monitoring
- Overview
- Application Monitoring Details
-
Application Monitoring Configuration
- Configuration Details
- Configuring the MySQL Monitoring Item
- Configuring the HttpClient Monitoring Item
- Configuring the URL Monitoring Item
- Configuring the JavaMethod Monitoring Item
- Configuring the Druid Monitoring Item
- Configuring the ApacheHttpAsyncClient Monitoring Item
- Configuring the Redis Monitoring Item
- Configuring the Jedis Monitoring Item
- Configuring the HBase Monitoring Item
- Configuring the ApacheHttpClient Monitoring Item
- Configuring the Tomcat Monitoring Item
- Configuring the EsRestClient Monitoring Item
- Configuring the WebSocket Monitoring Item
- Configuring the KafkaProducer Monitoring Item
- Configuring the Hikari Monitoring Item
- Configuring the Exception Monitoring Item
- Configuring the Thread Monitoring Item
- Configuring the GC Monitoring Item
- Configuring the JVMInfo Monitoring Item
- Configuring the JVMMonitor Monitoring Item
- Configuring ProbeInfo Monitoring Item
- Monitoring Item Views
- Tracing
- Application Topology
- URL Tracing
- Resource Tag Management
- Managing Tags
- Alarm Management
- Agent Management
- Configuration Management
- System Management
- Permissions Management
- FAQs
- Change History
-
Service Overview
- General Reference
Copied.
Making an API Request
This section describes the structure of a Representational State Transfer (REST) API request, and uses the Identity and Access Management (IAM) API for obtaining a user token as an example to demonstrate how to call an API. The obtained token can then be used to authenticate the calling of other APIs.
Request URI
A request URI is in the following format:
{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}
Although a request URI is included in the request header, most programming languages or frameworks require the request URI to be transmitted separately.
- URI-scheme: Protocol used to transmit requests. All APIs use HTTPS.
- Endpoint: Domain name or IP address of the server bearing the REST service. It can be obtained from Regions and Endpoints.
- resource-path: Access path of an API for performing a specified operation. Obtain the path from the URI of an API. For example, the resource-path of the API used to obtain a user token is /v3/auth/tokens.
- query-string: Query parameter, which is optional. Ensure that a question mark (?) is included before each query parameter that is in the format of "Parameter name=Parameter value". For example, ? limit=10 indicates that a maximum of 10 data records will be displayed.
For example, to obtain the IAM token in the XXX region, obtain the endpoint of IAM for this region and the resource-path in the URI of the API used to obtain a user token. Then, construct the URI as follows:

To simplify the URI display in this document, each API is provided only with a resource-path and a request method. The URI-scheme of all APIs is HTTPS, and the endpoints of all APIs in the same region are identical.
Request Methods
The HTTP protocol defines the following request methods that can be used to send a request to the server:
- GET: requests the server to return specified resources.
- PUT: requests the server to update specified resources.
- POST: requests the server to add resources or perform special operations.
- DELETE: requests the server to delete specified resources, for example, an object.
- HEAD: requests a server resource header.
- PATCH: requests the server to update partial content of a specified resource. If the resource does not exist, a new resource will be created.
For example, in the case of the API used to obtain a user token, the request method is POST. The request is as follows:
POST https://Endpoint/v3/auth/tokens
Request Header
You can also add additional header fields to a request, such as the fields required by a specified URI or HTTP method. For example, to request for the authentication information, add Content-Type, which specifies the request body type.
Common request header fields are as follows:
- Content-Type: specifies the request body type or format. This field is mandatory and its default value is application/json. Other values of this field will be provided for specific APIs if any.
- X-Auth-Token: specifies a user token only for token-based API authentication. The user token is a response to the API used to obtain a user token. This API is the only one that does not require authentication.
In addition to supporting token-based authentication, APIs also support authentication using access key ID/secret access key (AK/SK). During AK/SK-based authentication, an SDK is used to sign the request, and the Authorization (signature information) and X-Sdk-Date (time when the request is sent) header fields are automatically added to the request.
For more details, see AK/SK-based Authentication.
The API used to obtain a user token does not require authentication. Therefore, only the Content-Type field needs to be added to requests for calling the API. An example of such requests is as follows:
POST https://Endpoint/v3/auth/tokens Content-Type: application/json
Request Body
The body of a request is often sent in a structured format as specified in the Content-Type header field. The request body transfers content except the request header.
The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods.
In the case of the API used to obtain a user token, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace username, , ******** (login password), and xxxxxxxxxxxxxxxxxx (project ID) with the actual values. To learn how to obtain a project ID, see Obtaining a Project ID.
The scope parameter specifies where a token takes effect. You can set scope to an account or a project under an account. In the following example, the token takes effect only for the resources in a specified project.
POST https://Endpoint/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "id": "xxxxxxxxxxxxxxxxxx" } } } }
If all data required for the API request is available, you can send the request to call the API through curl, Postman, or coding. In the response to the API used to obtain a user token, x-subject-token is the desired user token. This token can then be used to authenticate the calling of other APIs.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot