创建镜像共享规则 - CreateRepoShare
功能介绍
创建镜像共享规则。镜像上传后,您可以共享私有镜像给其他账号或者组织单元,并授予下载该镜像的权限。
接口约束
无
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
POST /v2/manage/namespaces/{namespace}/repos/{repository}/shares
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| namespace | 是 | String | 组织名称。小写字母开头,后面跟小写字母、数字、小数点、下划线或中划线(其中下划线最多允许连续两个,小数点、下划线、中划线不能直接相连),小写字母或数字结尾,1-64个字符。 |
| repository | 是 | String | 镜像仓库名称。小写字母或数字开头,后面跟小写字母、数字、小数点、斜杠、下划线或中划线(其中下划线最多允许连续两个,小数点、斜杠、下划线、中划线不能直接相连),小写字母或数字结尾,1-128个字符。如果您的镜像名称repository参数中有斜杠,请先替换成$再进行请求。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | String | 消息体的类型(格式),下方类型可任选其一使用: application/json;charset=utf-8 application/json |
| X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| share_type | 是 | String | 共享类型。目前只支持account,organization |
| share_principals | 是 | Array of strings | 被共享者的信息列表。 |
| permission | 是 | String | 当前只支持read权限 |
| deadline | 是 | String | 截止时间,UTC时间格式。永久有效为forever |
| description | 否 | String | 描述 |
响应参数
状态码:201
无
请求示例
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"
} 响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 201 | 创建成功 |
| 400 | 错误的请求 |
| 401 | 鉴权失败 |
| 409 | 共享对象已存在 |
| 500 | 内部错误 |
错误码
请参见错误码。