- Service Overview
- User Guide
-
API Reference
- Before You Start
- API Overview
- Calling APIs
- Application Examples
-
API v2 (Recommended)
- Agreement Management
- Attachment Management
- Service Ticket Management
- Service Ticket Permission Management
- Attachment Management
- Authorization Management
- Service Ticket Quota Management
-
Basic Ticket Configuration Query
- Querying Country/Region Code
- Querying Problem Type List
- Querying Additional Parameters
- Querying Problem Type Template
- Querying Service Ticket Category List
- Querying Product Type List
- Querying Region List
- Service Ticket Satisfaction Category List
- Querying Problem Severity List
- Querying Service Ticket Limits (Such As Limited CCs in an Email)
- Label Management
- Ticket Message Management
-
Ticket Query
- Querying Agency Information
- Querying Partner Service Ticket Permissions
- Statistics of Service Tickets in Various Statuses
- Querying Service Ticket Details
- Querying Service Ticket Operation Logs
- Querying Service Ticket CC
- Querying Service Ticket Status
- Querying Associated Partner Service Information
- Querying Service Ticket List Interface
- Querying Sub-User Information
- Management of Associated Tickets
- Verification Code Management
- Appendix
Show all
Authentication
- Token-based authentication: Requests are authenticated using a token.
- AK/SK-based authentication: Requests are authenticated by encrypting the request body using an AK/SK pair. AK/SK-based authentication is recommended because it is more secure than token-based authentication.
Token
NOTE:
The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API used to obtain a user token.
A token specifies temporary permissions in a computer system. In token-based authentication, the token is added to requests to obtain permissions for calling an API.
In Making an API Request, the process of calling the API used to obtain a user token is described. After a token is obtained, the X-Auth-Token header field must be added to requests to specify the token for calling other APIs. For example, if the token is ABCDEFJ...., X-Auth-Token: ABCDEFJ.... can be added to a request as follows:
1 2 3 |
POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ.... |
AK/SK-Based Authentication
NOTE:
AK/SK-based authentication supports API requests with a body not larger than 12 MB. For API requests with a larger body, token-based authentication is recommended.
In AK/SK-based authentication, AK/SK is used to sign requests and the signature is then added to the requests for authentication.
- AK indicates the ID of the access key, It is the unique ID associated with the SK. The AK and SK are used together to obtain an encrypted signature for a request.
- SK indicates the secret access key used together with the AK to sign requests cryptographically. AK and SK can be used together to identify a request sender to prevent the request from being modified.
In AK/SK-based authentication, you can use an AK/SK to sign requests based on the signature algorithm or use the signing SDK to sign requests. For details about how to sign requests and use the signing SDK, see API Request Signing Guide.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
