文档中心>数据保险箱>API 文档>保险箱管理>在指定账号下创建保险箱

在指定账号下创建保险箱

最近更新时间:2023-10-08 09:17:18

接口描述

  • 接口名称:PutCoffer
  • 接口功能:该请求接⼝可以在指定账号下创建⼀个数据保险箱,创建数据保险箱的⽤户默认成为数据保险箱的持有者。

请求

请求示例

PUT /<CofferName-APPID> HTTP/1.1
Host: service.cdcs.myqcloud.com
Date: GMT Date
Content-Length: 0
Authorization: Auth String

说明:

Authorization: Auth String 的详情,请参⻅ 请求签名 ⽂档。

请求参数

此接⼝⽆请求参数。

请求头

此接⼝仅使⽤公共请求头部,详情请参⻅ 公共请求头部 ⽂档。

请求体

该 API 接⼝请求的请求体具体节点内容为:

{
    "Locations": {
        "Location": ["ap-tianjin"]
    },
    "EncryptType": 0,
    "KeyId": "",
    "KeyRegion": ""
}

具体内容描述如下:

节点名称(关键字) 是否必选 类型 描述
EncryptType int 加密类型:
  • 0 = 不加密(默认)
  • 1 = 使⽤公共主密钥
  • 2 = 使⽤ KMS 主密钥。
  • KeyId string 主密钥的 ID,仅当 EncryptType = 2 时,填写该参数。
    KeyRegion string 主密钥的地域,仅当 EncryptType = 2 时,填写该参数。
    Locations Object 保险箱所在地域列表。
    Location Enum 保险箱所在地域,枚举值请参⻅ 地域和访问域名 ⽂档。
    例如ap-beijing,ap-hongkong,eu-frankfurt

    响应

    响应头

    此接⼝仅返回公共响应头部,详情请参⻅ 公共响应头部 ⽂档。

    响应体

    此接⼝响应体为空。

    错误码

    此接⼝的特殊错误信息如下所述,全部错误信息请参⻅ 错误码 ⽂档。

    错误码 HTTP 状态码 描述
    CofferAlreadyExists 409 Conflict 指定的保险箱已存在。
    CofferAlreadyOwnedByYou 409 Conflict 指定的保险箱已存在且由当前账户创建。
    AssumeRoleFailed 409 Conflict 扮演⻆⾊失败,检查是否已授予保险箱⻆⾊。
    KMSFailed 409 Conflict 调⽤ KMS 失败。

    示例

    请求

    PUT /examplecoffer-1250000000 HTTP/1.1
    Host: service.cdcs.myqcloud.com
    Date: Sun, 26 May 2019 14:51:38 GMT
    Content-Length: 207
    Authorization: [Auth String]
    Connection: close
    
    {
        "Locations": {
            "Location": ["ap-tianjin"]
        },
        "EncryptType": 0,
        "KeyId": "aaa-bbb-ccc",
        "KeyRegion": "ap-beijing"
    }

    响应

    HTTP/1.1 200 OK
    Content-Length: 0
    Connection: close
    Date: Sun, 26 May 2019 14:51:37 GMT
    Server: tencent-cdcs
    x-cdcs-request-id: NWNlYWE3ZjlfZDQyNzVkNjRfMzg1N18yNzFh****