Adding an Image Sharing Policy
Function
Create an image sharing policy. You can share your private images with other accounts or organizations and grant them permissions to pull the images.
Constraints
N/A
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
URI
POST /v2/manage/namespaces/{namespace}/repos/{repository}/shares
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| namespace | Yes | String | Organization name. Enter 1 to 64 characters, starting with a lowercase letter and ending with a lowercase letter or digit. Only lowercase letters, digits, periods (.), underscores (_), and hyphens (-) are allowed. Periods, underscores, and hyphens cannot be placed next to each other. A maximum of two consecutive underscores are allowed. |
| repository | Yes | String | Image repository name. The name contains 1 to 128 characters, starting and ending with a lowercase letter or digit. Only lowercase letters, digits, periods (.), slashes (/), underscores (_), and hyphens (-) are allowed. Periods, slashes, underscores, and hyphens cannot be placed next to each other. A maximum of two consecutive underscores are allowed. If the parameter value contains a slash (/), replace it with a dollar sign ($) before sending the request. |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| Content-Type | Yes | String | Message body type (format). Possible values: application/json;charset=utf-8 application/json |
| X-Auth-Token | Yes | String | User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| share_type | Yes | String | Sharing type. The value can be account or organization. |
| share_principals | Yes | Array of strings | Information about the principals the image will be shared with. |
| permission | Yes | String | Currently, only the read permission is supported. |
| deadline | Yes | String | Expiration time (UTC). forever indicates permanently valid. |
| description | No | String | Description. |
Response Parameters
Status code: 201
None
Example Requests
POST https://{endpoint}/v2/manage/namespaces/{namespace}/repos/{repository}/shares
{
"share_type" : "account",
"share_principals" : [ "fb3f175c1fd146ab8cdae3272be6107b" ],
"permission" : "read",
"deadline" : "2018-10-01T16:00:00.000Z",
"description" : "description"
} Example Responses
None
Status Codes
| Status Code | Description |
|---|---|
| 201 | Added. |
| 400 | Bad request. |
| 401 | Unauthorized. |
| 409 | Shared image already exists. |
| 500 | Internal error. |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot