文档首页> 资源访问管理 RAM> API参考> API> 资源共享实例> 更新资源共享实例
更新时间：2024-03-04 GMT+08:00
查看PDF
分享

更新资源共享实例

功能介绍

修改资源共享实例的特定属性。

调试

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

URI

PUT /v1/resource-shares/{resource_share_id}

表1 路径参数

参数

是否必选

参数类型

描述

resource_share_id

是

String

资源共享实例的ID。

最小长度：0

最大长度：36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

否

String

如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。
表3 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

资源共享实例的名称。

最小长度：1

最大长度：64

description

否

String

资源共享实例的描述。

最小长度：0

最大长度：256

allow_external_principals

否

Boolean

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

响应参数

状态码： 200

表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

请求示例

修改资源共享实例的名称或描述信息。

PUT https://{hostname}/v1/resource-shares/{resource_share_id}

{
  "name" : "string",
  "description" : "string"
}

响应示例

状态码： 200

请求成功。

{
  "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" : "2023-01-30T11:29:17.578Z",
    "updated_at" : "2023-01-30T11:29:17.578Z"
  }
}

状态码

状态码

描述

200

请求成功。

错误码

请参见错误码。

父主题： 资源共享实例
分享：

    相关文档

    相关产品