创建共享单元。
接口说明
阿里云资源共享(Resource Sharing)支持将一个账号下的指定资源共享给一个或多个目标账号使用。更多信息,请参见资源共享概述。
本文将提供一个示例,在cn-hangzhou
地域,使用资源目录管理账号创建一个名为test
的共享单元,将 VPC 交换机vsw-bp183p93qs667muql****
共享给资源目录内的成员172050525300****
。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ResourceShareName | string | 是 | 共享单元名称。 长度范围:1~50 个字符。 格式:允许输入英文字母、数字、中文、半角句号(.)、下划线(_)或短划线(-)。 | test |
Resources | object [] | 否 | 共享资源列表。 | |
ResourceType | string | 否 | 共享资源类型。 N 的取值范围:1~5,即每次最多添加 5 个共享资源。 支持共享的资源类型,请参见支持资源共享的云服务。 说明
Resources.N.ResourceId 与Resources.N.ResourceType 成对出现,需要同时设置。
| VSwitch |
ResourceId | string | 否 | 共享资源 ID。 N 的取值范围:1~5,即每次最多添加 5 个共享资源。 说明
Resources.N.ResourceId 与Resources.N.ResourceType 成对出现,需要同时设置。
| vsw-bp183p93qs667muql**** |
Targets | array | 否 | 资源使用者。 | |
string | 否 | 172050525300**** | ||
PermissionNames | array | 否 | 共享权限名称。为空时,系统自动绑定资源类型关联的默认权限。具体信息,请参见权限库。 | |
string | 否 | 共享权限名称。为空时,系统自动绑定资源类型关联的默认权限。具体信息,请参见权限库。 | AliyunRSDefaultPermissionVSwitch | |
AllowExternalTargets | boolean | 否 | 是否允许共享给资源目录外的账号。取值:
| false |
TargetProperties | object [] | 否 | 资源使用者属性。 说明
仅当资源使用者为阿里云服务时可以设置该参数。
| |
TargetId | string | 否 | 资源使用者 ID。 说明
TargetProperties.N.TargetId 与TargetProperties.N.Property 成对出现,需要同时设置。
| 172050525300**** |
Property | string | 否 | 资源使用者属性参数。例如:您可以设置资源共享的时间段。
说明
TargetProperties.N.TargetId 与TargetProperties.N.Property 成对出现,需要同时设置。
| { "timeRange":{ "timeRangeType":"timeRange", "beginAtTime":"00:00", "timezone":"UTC+8", "endAtTime":"19:59" } } |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "2C3FA051-61DC-4F3E-81E9-E4830524DF4B",
"ResourceShare": {
"UpdateTime": "2020-12-03T08:02:22.413Z",
"ResourceShareName": "test",
"ResourceShareOwner": "151266687691****",
"CreateTime": "2020-12-03T08:02:22.413Z",
"ResourceShareId": "rs-qSkW1HBY****",
"ResourceShareStatus": "Active",
"AllowExternalTargets": false
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
共享单元名称无效。 | |||
共享单元名称字数超长(最大50字符)。 | |||
选定的共享资源无效。 | |||
选定的共享资源有重复项。 | |||
选定的共享资源数量超限(最大5个)。 | |||
资源使用者的参数不符合规则。 | |||
资源使用者有重复项。 | |||
资源使用者数量超限(最大5个)。 | |||
资源使用者不在资源目录内。 | |||
参数无效。 | |||
共享单元名称缺失。 | |||
传入的资源类型错误。 | |||
参数PermissionNames重复。 | |||
PermissionNames长度超限。 | |||
TargetProperties参数无效。 | |||
TargetProperties包含重复的参数。 | |||
TargetProperties数量超过限制。 | |||
共享权限不存在。 | |||
未开启与资源目录组织的共享。 | |||
资源使用者不在资源目录内。 | |||
共享单元数量超出限制。 | |||
共享单元ID已存在。 | |||
共享的资源超出单个账号最大限制。 | |||
资源使用者不能是自己。 | |||
当前资源类型仅支持资源目录的管理账号共享资源。如仍需使用当前账号,请联系管理账号将当前账号设置为当前资源类型所属可信服务的委派管理员账号。 | |||
邀请数量超出限制。 | |||
共享目标账号的企业名称与共享者不一致。 | |||
共享单元中包含不支持组织外共享的资源类型。 | |||
共享目标账号与共享者站点不一致。 | |||
此资源类型已经通过其他共享单元共享给目标云服务,请在同一个共享单元中共享。 | |||
同一个资源不允许重复共享给目标云服务。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
看变更集 | ||||||||||||||||
| ||||||||||||||||
看变更集 | ||||||||||||||||
| ||||||||||||||||
看变更集 | ||||||||||||||||
| ||||||||||||||||
看变更集 | ||||||||||||||||
| ||||||||||||||||
看变更集 | ||||||||||||||||
| ||||||||||||||||
看变更集 | ||||||||||||||||
|