Updated on 2026-08-25 GMT+08:00

Creating an Access Point

This API is used to create an access point.

For details, see Calling APIs.

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

kms:accessPoint:create

Write

accessPoint *

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
kms:accessPoint:create	Write	accessPoint *	-	-	-

POST /v1.0/{project_id}/kms/access-points

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A Range The value returned by the IAM API is used, which contains 32 characters. Default Value N/A

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range Obtain the value by calling the IAM API for obtaining the user token. Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
keyspace_id	Yes	String	Definition ID of the trusted key space to which the access point belongs. Constraints The value is in UUID format and must match the regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$. Range N/A Default Value N/A
access_point_name	Yes	String	Definition Access point name Constraints The value must match the regular expression ^[a-zA-Z0-9:/_-]{1,255}$. Range 1-255 Default Value N/A
type	Yes	Integer	Definition Access point type Constraints N/A Range 1: ECS 2: CCE 3: Custom Default Value N/A
identity	No	String	Definition Access point ID Constraints For an ECS access point, enter the value of ecs_id. For a CCE access point, enter the public key information of the CCE cluster. For a custom access point, you do not need to specify this parameter. When a custom access point is created, a key pair is generated. You can download the private key and use it for signature, which will be verified by the server. Range N/A Default Value N/A
cluster_id	No	String	Definition CCE cluster ID. This parameter is mandatory when you create a CCE access point. Constraints N/A Range N/A Default Value N/A
description	No	String	Definition Access point description Constraints N/A Range 1-255 Default Value N/A

Status code: 201

**Table 4** Response body parameters
Parameter	Type	Description
access_point_id	String	Definition ID of the created access point Range N/A

None

None

Status Code	Description
201	Request succeeded.

Parent Topic: Key Space