文档首页/ 资源访问管理 RAM/ API参考/ API/ 资源共享实例/ 创建资源共享实例 - CreateResourceShare
更新时间:2026-08-06 GMT+08:00
分享

创建资源共享实例 - CreateResourceShare

功能介绍

创建一个资源共享实例。您可以指定需要共享的资源列表,资源使用者列表,以及授予资源使用者的权限列表。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    ram:resourceShares:create

    Write

    -

    • g:RequestTag/<tag-key>

    • g:TagKeys

    • ram:RequestedResourceType

    • ram:ResourceUrn

    • ram:Principal

    • ram:TargetOrgPaths

    • ram:RequestedAllowExternalPrincipals

    -

    -

URI

POST /v1/resource-shares

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

String

参数解释

如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。

约束限制

不涉及

取值范围

只能由英文字母、数字、加号、斜杠、等号及连字符组成,长度为1~16384个字符。

默认取值

不涉及

表2 请求Body参数

参数

是否必选

参数类型

描述

name

String

参数解释

资源共享实例的名称。

约束限制

不涉及

取值范围

只能由中文字符、英文字母、数字及“_”、“-”、“.”组成,且长度为1~64个字符。

默认取值

无默认值

description

String

参数解释

资源共享实例的描述。

约束限制

不能包含“<” 与 “>”

取值范围

只能由中文、字母、数字及"_"、"-"、"."组成,且长度为0~256个字符。

默认取值

无默认值

allow_external_principals

Boolean

参数解释

资源共享实例是否支持共享给组织外账号。

约束限制

不涉及

取值范围

  • false: 资源共享实例不支持共享给组织外账号。

  • true: 资源共享实例支持共享给组织外账号。

默认取值

true

permission_ids

Array of strings

参数解释

资源共享实例关联的RAM权限列表。一种资源类型只能关联一个RAM权限。如果您没有指定权限ID,RAM将自动为每个资源类型关联默认权限。数组元素为权限ID格式的字符串,只能由英文字母、数字及'-'、'_'组成,长度为1~36个字符,可通过查询共享资源权限列表接口获取。

约束限制

不涉及

principals

Array of strings

参数解释

资源共享实例关联的一个或多个资源使用者的列表。数组元素为账号ID或URN格式的字符串。

约束限制

不涉及

resource_urns

Array of strings

参数解释

资源共享实例关联的一个或多个共享资源URN的列表。数组元素为资源URN格式的字符串,格式为 [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]:[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]:[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]:[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]:[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br],可通过查询共享资源列表接口获取。

约束限制

不涉及

tags

Array of Tag objects

参数解释

资源共享标签列表。

约束限制

不涉及

表3 Tag

参数

是否必选

参数类型

描述

key

String

参数解释

标签"键"的标识符或名称。

约束限制

不涉及

取值范围

只能由字母、数字、中文、下划线、点号、冒号、等号、加号、连字符、@符号及空格组成,不能以空格或"sys"开头,也不能以空格结尾。且长度为1~128个字符。

默认取值

不涉及

value

String

参数解释

标签"键"对应的"值"。您可以将标签的值设置为空字符串,但不能设置为null。

约束限制

不涉及

取值范围

只能由字母、数字、中文、下划线、点号、冒号、斜杠、等号、加号、连字符、@符号及空格组成。且长度为0~255个字符。

默认取值

不涉及

响应参数

状态码:201

表4 响应Body参数

参数

参数类型

描述

resource_share

ResourceShare object

描述RAM中的资源共享。

表5 ResourceShare

参数

参数类型

描述

id

String

参数解释

资源共享实例的ID

取值范围

只能由英文字母、数字及“-”组成,长度为0~36个字符。

name

String

参数解释

资源共享实例的名称。

取值范围

只能由中文字符、英文字母、数字及“_”、“-”、“.”组成,长度为0~128个字符。

description

String

参数解释

资源共享实例的描述。

取值范围

不涉及。

allow_external_principals

Boolean

参数解释

资源共享实例是否支持共享给组织外账号。

取值范围

  • false: 资源共享实例不支持共享给组织外账号。

  • true: 资源共享实例支持共享给组织外账号。

owning_account_id

String

参数解释

资源共享实例的所有者ID。

取值范围

只能由英文字母、数字及“-”组成,长度为0~36个字符。

status

String

参数解释

资源共享实例的状态。

取值范围

  • active:资源共享实例处于活跃状态。

  • deleting:资源共享实例正在删除中。

  • deleted:资源共享实例已删除。

  • failed:资源共享实例创建失败。

tags

Array of Tag objects

参数解释

资源共享实例的标签列表。

created_at

String

参数解释

创建资源共享实例的时间。UTC时间格式,格式为yyyy-MM-ddTHH:mm:ssZ,例如2020-09-25T12:05:00Z。

取值范围

不涉及

updated_at

String

参数解释

最后一次更新资源共享实例的时间。UTC时间格式,格式为yyyy-MM-ddTHH:mm:ssZ,例如2020-09-25T12:05:00Z。

取值范围

不涉及

表6 Tag

参数

参数类型

描述

key

String

参数解释

标签"键"的标识符或名称。

取值范围

只能由字母、数字、中文、下划线、点号、冒号、等号、加号、连字符、@符号及空格组成,不能以空格或"sys"开头,也不能以空格结尾。且长度为1~128个字符。

value

String

参数解释

标签"键"对应的"值"。您可以将标签的值设置为空字符串,但不能设置为null。

取值范围

只能由字母、数字、中文、下划线、点号、冒号、斜杠、等号、加号、连字符、@符号及空格组成。且长度为0~255个字符。

请求示例

创建一个资源共享实例,并指定需要共享的资源,资源使用者,授予资源使用者的权限,以及资源共享实例的标签。

POST /v1/resource-shares

{
  "name" : "string",
  "description" : "string",
  "permission_ids" : [ "string" ],
  "principals" : [ "string" ],
  "resource_urns" : [ "dns::123abc:zone:123abc" ],
  "tags" : [ {
    "key" : "string",
    "value" : "string"
  } ]
}

响应示例

状态码:201

请求成功。

{
  "resource_share" : {
    "id" : "string",
    "name" : "string",
    "description" : "string",
    "allow_external_principals" : true,
    "owning_account_id" : "string",
    "status" : "string",
    "tags" : [ {
      "key" : "string",
      "value" : "string"
    } ],
    "created_at" : "2022-09-27T03:14:08.883Z",
    "updated_at" : "2022-09-27T03:14:08.883Z"
  }
}

状态码

状态码

描述

201

请求成功。

错误码

请参见错误码

相关文档