跳转到主要内容
API Explorer|API Explorer
系统管理/安全设置相关接口/AccessKey管理相关接口
POSTSecurity Settings Interfaces起始版本 4.0.0同步需要认证

创建AccessKey

创建AccessKey

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

请求体字段

  • accountUuidString必填

    账户UUID。

  • userUuidString必填

    用户UUID。

  • descriptionString

    资源的详细描述。

  • AccessKeyIDString

    生成访问密钥ID。

  • AccessKeySecretString

    生成访问密钥。

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventoryAccessKeyInventory必填

    详情参考inventory

    • uuidString必填

      资源的UUID，唯一标示该资源

    • descriptionString必填

      资源的详细描述

    • accountUuidString必填

      账户UUID

    • userUuidString必填

      该值已弃用

    • AccessKeyIDString必填

      访问密钥ID。

    • AccessKeySecretString必填

      访问密钥。

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • stateAccessKeyState必填

      详情参考state

      • nameString必填

        资源名称

      • ordinalint必填

        暂无描述。

请求地址

POST/zstack/v1/accesskeys

/zstack/v1/accesskeys

操作 ID

CreateAccessKey

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/accesskeys' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"accountUuid":"<accountUuid>","userUuid":"<userUuid>","description":"<description>","AccessKeyID":"<AccessKeyID>","AccessKeySecret":"<AccessKeySecret>","resourceUuid":"<resourceUuid>","systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "uuid": "01f82a92a3f83136b3a5fa13b0f1dde6", "accountUuid": "bc81e5aad7363ebaa904ee81edbfdd1f", "userUuid": "bc81e5aad7363ebaa904ee81edbfdd1f", "AccessKeyID": "1234567890abcdedfhij", "AccessKeySecret": "1234567890abcdedfhij1234567890abcdedfhij", "state": "Enabled" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史