更新时间:2024-03-04 GMT+08:00
分享

创建资源共享实例

功能介绍

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

调试

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

URI

POST /v1/resource-shares

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

String

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

表2 请求Body参数

参数

是否必选

参数类型

描述

name

String

资源共享实例的名称。

最小长度:1

最大长度:64

description

String

资源共享实例的描述。

最小长度:0

最大长度:256

allow_external_principals

Boolean

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

缺省值:true

permission_ids

Array of strings

资源共享实例关联的RAM权限列表。一种资源类型只能关联一个RAM权限。如果您没有指定权限ID,RAM将自动为每个资源类型关联默认权限。

最小长度:0

最大长度:36

数组长度:0 - 20

principals

Array of strings

资源共享实例关联的一个或多个资源使用者的列表。

最小长度:0

最大长度:1500

数组长度:0 - 20

resource_urns

Array of strings

资源共享实例关联的一个或多个共享资源URN的列表。

最小长度:0

最大长度:1500

数组长度:0 - 20

tags

Array of Tag objects

资源共享标签列表。

数组长度:0 - 20

表3 Tag

参数

是否必选

参数类型

描述

key

String

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

最小长度: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

资源共享实例的描述。

最小长度:1

最大长度:1024

allow_external_principals

Boolean

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

owning_account_id

String

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

最小长度:0

最大长度:36

status

String

资源共享实例的状态。

最小长度:0

最大长度:36

tags

Array of Tag objects

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

数组长度:0 - 100

created_at

String

创建资源共享实例的时间。

updated_at

String

最后一次更新资源共享实例的时间。

表6 Tag

参数

参数类型

描述

key

String

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

最小长度:1

最大长度:128

value

String

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

最小长度:0

最大长度:255

请求示例

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

POST https://{hostname}/v1/resource-shares

{
  "name" : "string",
  "description" : "string",
  "permission_ids" : [ "string" ],
  "principals" : [ "string" ],
  "resource_urns" : [ "string" ],
  "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

请求成功。

错误码

请参见错误码

分享:

    相关文档

    相关产品