Adding Image Members¶

Scenario¶

An image can be shared with multiple tenants. The API used add tenants is an extension API.

Note

The token obtained from IAM is valid for only 24 hours. If you want to use a token for authentication, you can cache it to avoid frequently calling the IAM API.

Involved APIs¶

If you use a token for authentication, you must obtain the token and add X-Auth-Token to the request header of the IMS API when making an API call.

IAM API used to obtain the token
URI format: POST https://IAM endpoint/v3/auth/tokens
IMS API used to add image members
URI format: POST https://IMS endpoint/v1/cloudimages/members

Procedure¶

Obtain the token.
Send POST https://IMS endpoint/v1/cloudimages/members.
Add X-Auth-Token to the request header.

Configure the request parameters. (The values are examples only.)

{
    "images": [
        "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
        "0b680482-acaa-4045-b14c-9a8c7dfe9c70"
    ],  //Image IDs (mandatory, list<string>)
    "projects": [
        "9c61004714024f9586705d090530f9fa",
        "edc89b490d7d4392898e19b2deb34797"
    ],  //Project IDs (mandatory, list<string>)
}

If the request is successful, a job ID is returned.

Query job details using the job ID by referring to Querying Job Details.
If the job status is SUCCESS, the private image is successfully created.
For details about status codes for request errors, see Status Codes.

last updated: 2024-11-13 15:15 UTC - commit: b636e55e81d9b75131fd075994c6c3e2fb2c5042