文档首页/ 镜像服务 IMS/ API参考/ API/ 镜像共享/ 批量更新镜像成员状态
更新时间:2024-06-24 GMT+08:00
分享

批量更新镜像成员状态

功能介绍

该接口为扩展接口,主要用于用户接受或者拒绝多个共享镜像时批量更新镜像成员的状态。

该接口为异步接口,返回job_id说明任务下发成功,查询异步任务状态,如果是success说明任务执行成功,如果是failed说明任务执行失败。如何查询异步任务,请参见异步任务查询

调试

您可以在API Explorer中调试该接口。

URI

PUT /v1/cloudimages/members

请求消息

请求参数

参数

是否必选

参数类型

描述

images

Array of strings

镜像ID列表。

project_id

String

项目ID。

status

String

镜像成员的状态。

取值如下:

  • accepted:表示接受共享镜像。接受后,该镜像在用户镜像列表中可见,用户可以使用该镜像创建云服务器。
  • rejected:表示拒绝共享镜像。拒绝后,该镜像在用户镜像列表中不可见,但是,用户仍然可以使用该镜像创建云服务器。

vault_id

String

存储库ID。

如果是通过CBR创建的整机镜像,则在接受该共享镜像时,为必选参数,需传入该值。

存储库ID可以从云备份服务控制台获取,或者参考“查询存储库列表”查询。

请求示例

  • 批量更新镜像成员状态,其中,镜像状态为“接受共享镜像”。
    1
    2
    3
    4
    5
    6
    7
    8
    9
    PUT https://{Endpoint}/v1/cloudimages/members
    {
       "images": [
              "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
              "0b680482-acaa-4045-b14c-9a8c7dfe9c70"
          ],
          "project_id": "edc89b490d7d4392898e19b2deb34797",
          "status": "accepted"
    }
    
  • 批量更新通过CBR创建的整机镜像成员状态,其中,镜像状态为“接受共享镜像”,存储库ID为“d14r5tef-1bc3-4c4f-823e-3e471rg65e65”
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    PUT https://{Endpoint}/v1/cloudimages/members
    {
       "images": [
              "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
              "0b680482-acaa-4045-b14c-9a8c7dfe9c70"
          ],
          "project_id": "edc89b490d7d4392898e19b2deb34797",
          "status": "accepted",
          "vault_id": "d14r5tef-1bc3-4c4f-823e-3e471rg65e65"
    }
    

响应消息

  • 响应参数

    参数

    参数类型

    描述

    job_id

    String

    异步任务ID。

    详情请参见异步任务查询

  • 响应样例
    STATUS CODE 200
    1
    2
    3
    {
        "job_id": "edc89b490d7d4392898e19b2deb34797"
    }
    

返回值

  • 正常

    200

  • 异常

    返回值

    说明

    400 Bad Request

    请求错误,具体返回错误码请参错误码

    401 Unauthorized

    鉴权失败。

    403 Forbidden

    没有操作权限。

    404 Not Found

    找不到资源。

    500 Internal Server Error

    服务内部错误。

    503 Service Unavailable

    服务不可用。

相关文档