跳转到主要内容
API Explorer|API Explorer
运营管理/访问控制/AccessKey相关接口
PUTAccessKey Operations起始版本 3.2.0同步需要认证

开启或关闭AccessKey

开启或关闭AccessKey

调试可用性

在线调试

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

路径参数

请求参数

路径参数

  • uuidString必填

    AccessKey UUID，唯一标示该资源

请求体字段

  • changeaccesskeystateObject必填

    changeaccesskeystate 请求体结构

    • stateEventString必填

      开启或关闭

  • systemTagsList

    系统标签。

  • userTagsList

    用户标签。

响应状态

200 OK

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

  • 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必填

      用户UUID

    • AccessKeyIDString必填

      访问密钥ID。

    • AccessKeySecretString必填

      访问密钥。

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • stateAccessKeyState必填

      详情参考state

      • nameString必填

        资源名称

      • ordinalint必填

        暂无描述。

请求地址

PUT/zstack/v1/accesskeys/{uuid}/actions

/zstack/v1/accesskeys/{uuid}/actions

操作 ID

ChangeAccessKeyState

永久链接

请求示例

curl -X PUT 'http://{host}/zstack/v1/accesskeys/{uuid}/actions' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"changeaccesskeystate":{"stateEvent":"<stateEvent>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "uuid": "defe79b1a43f35818dc6d3959b571773", "accountUuid": "d0c06c8d19f439b1b8f481dbdf3e3a3c", "userUuid": "b622d5d01ef63237878023e93ade5003", "AccessKeyID": "1234567890abcdedfhij", "AccessKeySecret": "1234567890abcdedfhij1234567890abcdedfhij", "state": "Enabled" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史