链接复制成功!
创建资源共享实例 - CreateResourceShare
功能介绍
创建一个资源共享实例。您可以指定需要共享的资源列表,资源使用者列表,以及授予资源使用者的权限列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
POST /v1/resource-shares
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Security-Token | 否 | String | 参数解释: 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 约束限制: 不涉及 取值范围: 只能由英文字母、数字组成,且长度为至少 1 个字符 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 是 | String | 参数解释: 资源共享实例的名称。 约束限制: 不涉及 取值范围: 只能由中文字符、英文字母、数字及“_”、“-”、“.”组成,且长度为[1~64]个字符。 默认取值: 无默认值 |
| description | 否 | String | 参数解释: 资源共享实例的描述。 约束限制: 不能包含“<” 与 “>” 取值范围: 只能由中文、字母、数字及"_"、"-"、"."组成,且长度为[0~256]个字符。 默认取值: 无默认值 |
| allow_external_principals | 否 | Boolean | 参数解释: 资源共享实例是否支持共享给组织外账号。 约束限制: 不涉及 取值范围: 默认取值: true |
| permission_ids | 否 | Array of strings | 参数解释: 资源共享实例关联的RAM权限列表。一种资源类型只能关联一个RAM权限。如果您没有指定权限ID,RAM将自动为每个资源类型关联默认权限。 约束限制: 不涉及 |
| principals | 否 | Array of strings | 参数解释: 资源共享实例关联的一个或多个资源使用者的列表。 约束限制: 不涉及 |
| resource_urns | 否 | Array of strings | 参数解释: 资源共享实例关联的一个或多个共享资源URN的列表。 约束限制: 不涉及 |
| tags | 否 | Array of Tag objects | 资源共享标签列表。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| key | 是 | String | 参数解释: 标签"键"的标识符或名称。 约束限制: 不涉及 取值范围: 只能由字母、数字、中文、下划线、点号、冒号、等号、加号、连字符、@符号及空格组成,不能以空格或"sys"开头,也不能以空格结尾。且长度为[1~128]个字符。 默认取值: 不涉及 |
| value | 是 | String | 参数解释: 标签"键"对应的"值"。您可以将标签的值设置为空字符串,但不能设置为null。 约束限制: 不涉及 取值范围: 只能由字母、数字、中文、下划线、点号、冒号、斜杠、等号、加号、连字符、@符号及空格组成。且长度为[0~255]个字符。 默认取值: 不涉及 |
响应参数
状态码:201
| 参数 | 参数类型 | 描述 |
|---|---|---|
| resource_share | ResourceShare object | 描述RAM中的资源共享。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| 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 | 参数解释: 资源共享实例的标签列表。 约束限制: 不涉及 |
| created_at | String | 参数解释: 创建资源共享实例的时间。 约束限制: 不涉及 取值范围: 对应 RFC 3339 规范的日期时间格式,yyyy-MM-ddTHH:mm:ss.SSSZ 默认取值: 无默认值 |
| updated_at | String | 参数解释: 最后一次更新资源共享实例的时间。 约束限制: 不涉及 取值范围: 对应 RFC 3339 规范的日期时间格式,yyyy-MM-ddTHH:mm:ss.SSSZ 默认取值: 无默认值 |
请求示例
创建一个资源共享实例,并指定需要共享的资源,资源使用者,授予资源使用者的权限,以及资源共享实例的标签。
POST /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 | 请求成功。 |
错误码
请参见错误码。