- What's New
- Product Bulletin
- Service Overview
- Billing
- Getting Started
-
User Guide
- Application Service Mesh
- Buying a Service Mesh
- Mesh Management
- Service Management
- Gateway Management
- Grayscale Release
- Mesh Configuration
- Traffic Management
- Security
-
Best Practices
- Upgrading Data Plane Sidecars Without Service Interruption
- Service Governance for Dubbo-based Applications
- Reserving Source IP Address for Gateway Access
- How Do I Create a Service Mesh with IPv4/IPv6 Dual Stack Enabled
- How Do I Query Application Metrics in AOM?
- Reducing the Agency Permissions of ASM Users
- Istio-ingressgateway HA Configuration
- API Reference
-
FAQs
- Service Mesh Cluster
-
Mesh Management
- Why Cannot I Create a Service Mesh for My Cluster?
- Why Are Exclusive Nodes Still Exist After Istio Is Uninstalled?
- How Do I Upgrade ICAgent?
- How Do I Enable Namespace Injection for a Cluster?
- How Do I Disable Sidecar Injection for Workloads?
- What Can I Do If a Pod Cannot Be Started Due to Unready Sidecar?
- Why Does the Owner Group of the File Mounted to the Service Container Change After Configuring fsgroup?
- How Do I Handle a Canary Upgrade Failure?
- Possible Causes of Sidecar Injection Failures
-
Adding a Service
- What Do I Do If an Added Gateway Does Not Take Effect?
- Why Does It Take a Long Time to Start the Demo Application in Experiencing Service Mesh in One Click?
- Why Cannot I Access the Page of the Deployed Demo Application?
- Why Does Error Code 500 Is Displayed When I Create a Gateway?
- Why Cannot I Select the Corresponding Service When Adding a Route?
- What Should I Do If the Application Data Fails to Be Obtained?
- How Do I Inject a Sidecar for the Pod Created Using a Job or Cron Job?
- Performing Grayscale Release
-
Managing Traffic
- Why Are the Created Clusters, Namespaces, and Applications Not Displayed on the Traffic Management Page?
- How Do I Change the Resource Requests of the istio-proxy Container?
- Does ASM Support HTTP/1.0?
- How Can I Block Access from Some IP Address Ranges or Ports for a Service Mesh?
- How Do I Configure max_concurrent_streams for a Gateway?
- How Do I Fix Compatibility Issues Between Istio CNI and Init Containers?
-
Monitoring Traffic
- Why Cannot I View Traffic Monitoring Data Immediately After a Pod Is Started?
- Why Are the Latency Statistics on the Dashboard Page Inaccurate?
- Why Is the Traffic Ratio Inconsistent with That in the Traffic Monitoring Chart?
- Why Can't I Find Certain Error Requests in Tracing?
- Why Cannot I Find My Service in the Traffic Monitoring Topology?
- How Do I Connect a Service Mesh to Jaeger or Zipkin for Viewing Traces?
- Videos
-
More Documents
-
User Guide (ME-Abu Dhabi Region)
- Service Overview
- Getting Started
- User Guide
-
FAQs
- Service Mesh Cluster
- Mesh Management
-
Adding a Service
- What Do I Do If an Added Gateway Does Not Take Effect?
- Why Does It Take a Long Time to Start the Demo Application in Experiencing Service Mesh in One Click?
- Why Cannot I Access the page of the Demo Application After It Is Successfully Deployed?
- Why Cannot I Select the Corresponding Service When Adding a Route?
- Performing Grayscale Release
-
User Guide (ME-Abu Dhabi Region)
- General Reference
Copied.
Making an API Request
This section describes the structure of a REST API request, and uses the IAM API for 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 send requests. All APIs use HTTPS.
- Endpoint: domain name or IP address of the server bearing the REST service endpoint. Endpoints vary depending on services and regions.
- resource-path: API access path. Obtain the path from the URI of an API. For example, resource-path of the API used to obtain a user token is /v3/auth/tokens.
- query-string: query parameters, which are optional. Ensure that a question mark (?) is included in front of each query parameter that is in the format of "Parameter name=Parameter value". For example, ? limit=10 indicates that up to 10 data records will be displayed.
For example, if you want to obtain an IAM token in CN North-Beijing1, use the endpoint of IAM (iam.cn-north-1.myhuaweicloud.com) for this region and resource-path (/v3/auth/tokens) 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 resource-path and a request method. The URI-scheme value of all APIs is HTTPS, and the endpoints of all APIs in the same region are identical.
Request Methods
[Example]
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 the server to return the response header only.
- PATCH: requests the server to update partial content of a specified resource. If the resource is unavailable, the PATCH method is used to create a resource.
For example, in the URI for obtaining a user token, the request method is POST. The request is as follows:
POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens
Request Headers
[Example]
You can also add additional fields to a request, such as the fields required by a specified URI or HTTP method. For example, to request authentication information, add Content-Type, which specifies the request body type.
Common request headers 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. This field is mandatory only when token-based authentication is used. The user token is a response to the API for obtaining a user token. This API is the only one that does not require authentication.
- X-Project-ID: specifies a subproject ID. This field is optional and can be used in multi-project scenarios.
- X-Domain-ID: specifies an account ID.
Since the API for obtaining a user token does not require authentication, you only need to include the Content-Type header in the request, as shown below:
POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json
Request Body
A request body is generally sent in structured format as specified in Content-Type. It transfers content except the request header. If the request body contains Chinese characters, these characters must be encoded in UTF-8.
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.
For the API used to obtain a user token, you can view request parameters and parameter description in the API request. The following provides an example request with a body included. Replace username, domainname, ******** (login password), and xxxxxxxxxx (project name) with the actual values. To learn how to obtain the project name, see "Regions and Endpoints".
The scope parameter specifies where a token takes effect. You can set scope to an account or a project under an account.
Content-Type: application/json
{
"auth": {
"identity": {
"methods": [
"password"
],
"password": {
"user": {
"name": "username",
"password": "********",
"domain": {
"name": "domainname"
}
}
}
},
"scope": {
"project": {
"name": "xxxxxxxx"
}
}
}
}
If all data required for the API request is available, you can send the request to call an API through curl, Postman, or coding. In the response to the API used to obtain a user token, x-subject-token is the target user token. This token can 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