GS2-Key

Create Client

key_client = client('key')

Method

create_key

response = key_client:create_key(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

暗号鍵を新規作成します

Request

{
  name=string,
}

• name

• [string] 暗号鍵の名前

Response

• item

• [Key] 暗号鍵

decrypt

response = key_client:decrypt(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

復号化処理を実行します

Request

{
  keyName=string,
  data=string,
}

• keyName

• [string] 暗号鍵の名前を指定します。

• data

• [string] 暗号化されたデータ

Response

• data

• [string] 復号化済みデータ

delete_key

response = key_client:delete_key(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

暗号鍵を削除します

Request

{
  keyName=string,
}

• keyName

• [string] 暗号鍵の名前を指定します。

Response

None

describe_key

response = key_client:describe_key(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

暗号鍵の一覧を取得します

Request

{
  pageToken=string,
  limit=number,
}

• pageToken

• [string] データの取得を開始する位置を指定するトークン

• limit

• [number] データの取得件数

Response

• nextPageToken

• [string] 次のページを読み込むためのトークン

• items

• [table<Key>] 暗号鍵

encrypt

response = key_client:encrypt(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

暗号化処理を実行します

Request

{
  keyName=string,
  data=string,
}

• keyName

• [string] 暗号鍵の名前を指定します。

• data

• [string] 暗号化するデータ

Response

• data

• [string] 暗号化済みデータ

get_key

response = key_client:get_key(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

暗号鍵を取得します

Request

{
  keyName=string,
}

• keyName

• [string] 暗号鍵の名前を指定します。

Response

• item

• [Key] 暗号鍵

Model

Key

• ownerId

• [string] オーナーID

• keyId

• [string] 暗号鍵GRN

• updateAt

• [number] 最終更新日時(エポック秒)

• name

• [string] 暗号鍵名

• createAt

• [number] 作成日時(エポック秒)