Creating an Encryption and Masking Configuration

Function

This API is used to create an encryption and masking configuration.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/sdg/server/mask/algorithms/encryption-configurations

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Unique project ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
algorithm_name	No	String	Name of the encryption and masking algorithm.
algorithm_type	No	String	Type of the encryption and masking algorithm. The value can be SHA256, SHA512, PRESNM, MASKNM, PRESXY, MASKXY, SYMBOL, KEYWORD, NULL, EMPTY, DATE, NUMERIC, AES, EMBED, SM4, or DECRYPT.
encrypt_mode	No	String	Encryption mode, the value contains 1 to 256 characters.
filling_method	No	String	Padding method, which is used for encryption and masking.
key_len	No	Integer	Key length
kms_context	No	KmsContext object	KMS context information
rotate_period	No	Integer	Key rotation period (days)

**Table 3** KmsContext
Parameter	Mandatory	Type	Description
kms_key_alias	No	String	Alias of the KMS key
kms_key_id	No	String	Unique ID of the KMS key
kms_region	No	String	Region where the KMS is located

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
msg	String	Returned message content, which is used to describe the operation result.
status	String	Returned status code. For example, 200 indicates success, and 400 indicates an error.

Status code: 201

Resource creation.

Example Requests

POST /v1/{project_id}/sdg/server/mask/algorithms/encryption-configurations

{
  "algorithm_name" : "AES256",
  "algorithm_type" : "AES",
  "encrypt_mode" : "GCM",
  "filling_method" : "PKCS7",
  "key_len" : 128,
  "kms_context" : {
    "kms_region" : "cn-north-4",
    "kms_key_alias" : "KMS-a8af",
    "kms_key_id" : "a7187d26-xxxxxxxx-a6d68ccc202c"
  },
  "rotate_period" : 0
}