Updated on 2025-08-20 GMT+08:00

Authentication

You can use either of the authentication methods below to call APIs. AK/SK-based authentication is recommended because it is more secure than token-based authentication.
  • Token-based authentication: General requests are authenticated using tokens.
  • AK/SK-based authentication: Requests are authenticated by encrypting the request body using an AK/SK.

Token-based Authentication

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 certain permissions in a computer system. During token-based authentication, the token is added to requests to get permissions for calling the API.

When calling the API to obtain a user token, you must set auth.scope in the request body to project.

In Making an API Request, the process of calling the API used to obtain a user token is described.

{
	"auth": {
		"identity": {
			"methods": [
				"password"
			],
			"password": {
				"user": {
					"name": "user_name",
					"password": "user_password",
					"domain": {
						"name": "domain_name"
					}
				}
			}
		},
		"scope": {
			"project": {
				"name": "project_name"
			}
		}
	}
}

After a token is obtained, the X-Auth-Token header must be added to requests to specify the token when calling other APIs. For example, if the token is ABCDEFJ...., add X-Auth-Token: ABCDEFJ.... to a request as follows:

GET https://modelarts.ap-southeast-1.myhuaweicloud.com/v1/{project_id}/services
Content-Type: application/json
X-Auth-Token: ABCDEFJ....

AK/SK-based Authentication

AK/SK-based authentication supports API requests with a body not larger than 12 MB. For API requests with a larger body, token authentication is recommended.

In AK/SK-based authentication, AK/SK is used to sign requests and the signature is then added to the request for authentication.

  • AK: access key ID, which is a unique identifier used with a secret access key to sign requests cryptographically.
  • SK: secret access key, which is used in conjunction with an AK to sign requests cryptographically. It identifies a request sender and prevents the request from being modified.
In AK/SK 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.

The signature SDK supports only signature, which is different from the SDKs provided by services.