创建主密钥

请求url:

https://kms-northchina1-api.mtyun.com/
    Action=KMSCreateKey&
    请求参数&
    AUTHDATA

请求参数

参数名
类型
说明
可选值
示例
备注
Description string 密钥描述 可选    


返回参数

参数名
类型
说明
示例
备注
isEnabled bool 是否启用    
KeyID string 密钥ID    
Description string 密钥描述    
CreatedAt string 密钥创建时间    

 

返回示例(JSON)

{
  "KMSCreateKeyResponse": {
    "code":200,
    "ret": {
      "isEnabled": true,
      "KeyID": "KeyID",
      "Description": "创建成功",
      "CreatedAt": "2017-12-05T06:22:56.403Z",
    },
    "err": ""
  }
}

 

获取主密钥

请求url:

https://kms-northchina1-api.mtyun.com/mcs/v1/kms/
    Action=KMSRetrieveKey&
    请求参数&
    AUTHDATA

请求参数

参数名
类型
说明
可选值
示例
备注
KeyID string 密钥ID 必选    

 

返回参数

参数名
类型
说明
示例
备注
isEnabled bool 是否启用    
KeyID string 密钥ID    
Description string 密钥描述    
CreatedAt string 密钥创建时间    

 

返回示例(JSON)

 

{
  "KMSRetrieveKeyResponse": {
    "code":200,
    "ret": {
      "isEnabled": true,
      "KeyID": "KeyID",
      "Description": "获取成功",
      "CreatedAt": "2017-12-05T06:22:56.403Z",
    },
    "err": ""
  }
}

 

更新主密钥

请求url:

https://kms-northchina1-api.mtyun.com/mcs/v1/kms/
    Action=KMSUpdateKey&
    请求参数&
    AUTHDATA

请求参数

参数名
类型
说明
可选值
示例
备注
KeyID string 密钥ID 必选    
Description string 密钥描述 可选    

 

返回参数

参数名
类型
说明
示例
备注
isEnabled bool 是否启用    
KeyID string 密钥ID    
Description string 密钥描述    
CreatedAt string 密钥创建时间    

 

返回示例(JSON)

 

{
  "KMSUpdateKeyResponse": {
    "code":200,
    "ret": {
      "isEnabled": true,
      "KeyID": "KeyID",
      "Description": "更新成功",
      "CreatedAt": "2017-12-05T06:22:56.403Z",
    },
    "err": ""
  }
}

 

获取主密钥列表

请求url:

https://kms-northchina1-api.mtyun.com/mcs/v1/kms/
    Action=KMSListKeys&
    请求参数&
    AUTHDATA

请求参数

参数名
类型
说明
可选值
示例
备注
Limit int 分页大小 可选   默认为20
Offset int 分页偏移量 可选   默认为0

 

返回参数

参数名
类型
说明
示例
备注
count int 密钥个数    
isEnabled bool 是否启用    
KeyID string 密钥ID    
Description string 密钥描述    
CreatedAt string 密钥创建时间    

 

返回示例(JSON)

 

{
  "KMSListKeysResponse": {
    "count":1,
    "code":200,
    "err": "",
    "ret": [
    {
      "isEnabled": true,
      "KeyID": "KeyID",
      "Description": "获取成功",
      "CreatedAt": "2017-12-05T06:22:56.403Z",
    }
    ],
    "limit":100,
    "offset":0
  }
}

 

删除主密钥实例

请求url:

https://kms-northchina1-api.mtyun.com/mcs/v1/kms/
    Action=KMSDeleteKey&
    请求参数&
    AUTHDATA

请求参数

参数名 类型 说明 可选值 示例 备注
KeyID string 可用密钥ID 必选    

 

返回参数

参数名
类型
说明
示例
备注
ret bool 成功删除返回为true    

 

返回示例(JSON)

 

{
  "KMSDeleteKeyResponse": {
    "code":200,
    "ret": true
    "err": ""
  }
}

 

禁用主密钥

请求url:

https://kms-northchina1-api.mtyun.com/mcs/v1/kms/
    Action=KMSDisableKey&
    请求参数&
    AUTHDATA

请求参数

参数名
类型
说明
可选值
示例
备注
KeyID string 可用密钥ID 必选    

 

返回参数

参数名
类型
说明
示例
备注
isEnabled bool 是否启用    
KeyID string 密钥ID    
Description string 密钥描述    
CreatedAt string 密钥创建时间    

 

返回示例(JSON)

 

{
  "KMSDisableKeyResponse": {
    "code":200,
    "ret": {
      "isEnabled": true,
      "KeyID": "KeyID",
      "Description": "已禁用",
      "CreatedAt": "2017-12-05T06:22:56.403Z",
    },
    "err": ""
  }
}

 

启用主密钥

请求url:

https://kms-northchina1-api.mtyun.com/mcs/v1/kms/
    Action=KMSEnableKey&
    请求参数&
    AUTHDATA

请求参数

参数名
类型
说明
可选值
示例
备注
KeyID string 密钥ID 必选    

 

返回参数

参数名
类型
说明
示例
备注
isEnabled bool 是否启用    
KeyID string 密钥ID    
Description string 密钥描述    
CreatedAt string 密钥创建时间    

 

返回示例(JSON)

 

{
  "KMSEnableKeyResponse": {
    "code":200,
    "ret": {
      "isEnabled": true,
      "KeyID": "KeyID",
      "Description": "已启用",
      "CreatedAt": "2017-12-05T06:22:56.403Z",
    },
    "err": ""
  }
}

 

用主密钥加密

请求url:

https://kms-northchina1-api.mtyun.com/mcs/v1/kms/
    Action=KMSEncrypt&
    请求参数&
    AUTHDATA

请求参数

参数名
类型
说明
可选值
示例
备注
KeyID string 密钥ID 必选    
PlainText string 需要加密的明文 必选    

 

返回参数

参数名
类型
说明
示例
备注
ret string 加密后的密文    

 

返回示例(JSON)

 

{
  "KMSEncryptResponse": {
    "code":200,
    "ret": "Ciphertext",
    "err": ""
  }
}

 

用主密钥解密

请求url:

https://kms-northchina1-api.mtyun.com/mcs/v1/kms/
    Action=KMSDecrypt&
    请求参数&
    AUTHDATA

请求参数

参数名
类型
说明
可选值
示例
备注
CipherText string 需要解密的密文 必选    

 

返回参数

参数名
类型
说明
示例
备注
ret string 解密后的明文    

 

返回示例(JSON)

 

{
  "KMSDecryptResponse": {
    "code":200,
    "ret": "Hello world",
    "err": ""
  }
}