Help Center> Data Encryption Workshop> API Reference> APIs> Key Management APIs> DEK Management> Creating a Random Number
Updated on 2022-09-15 GMT+08:00
View PDF

Creating a Random Number

Function

This API generates a random number that is 8 bits to 8192 bits long.

URI

POST /v1.0/{project_id}/kms/gen-random

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

random_data_length

Yes

String

Bit length of a random number. The value is a multiple of 8, in the range 8 to 8192.

sequence

No

String

36-byte sequence number of a request message. Example: 919c82d4-8046-4722-9094-35c3c6524cff

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

random_data

String

Random number in hexadecimal format. Two characters represent 1 byte. Its length should match random_data_length.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error

Object

Error message.
Table 6 ErrorDetail

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error information.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error

Object

Error message.
Table 8 ErrorDetail

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error information.

Example Requests

{
  "random_data_length" : "512"
}

Example Responses

Status code: 200

Request processing succeeded.

{
  "random_data" : "5791C223E87120BE4B98D168F47A58BB2A88834EEADC"
}

Status code: 400

Invalid request parameters.

{
  "error" : {
    "error_code" : "KMS.XXX",
    "error_msg" : "XXX"
  }
}

Status code: 403

Authentication failed.

{
  "error" : {
    "error_code" : "KMS.XXX",
    "error_msg" : "XXX"
  }
}

Status Codes

Status Code

Description

200

Request processing succeeded.

400

Invalid request parameters.

403

Authentication failed.

Error Codes

See Error Codes.

Parent topic: DEK Management