华为云用户手册

资源访问管理 RAM-返回结果:响应消息体

响应消息体响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。对于检索共享资源权限列表接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 { "permissions": [ { "id": "7d04b6d4-00d5-41bd-b13c-22abd1ea249b", "name": "test-dns-zones", "resource_type": "dns:zone", "is_resource_type_default": true, "created_at": "2022-08-10T07:18:47Z", "updated_at": "2022-10-21T15:22:15Z" }, { "id": "8c378992-2450-4b2e-9c94-58fe01c74397", "name": "test-dns-resolverRules", "resource_type": "dns:resolverRule", "is_resource_type_default": true, "created_at": "2022-08-10T07:50:02Z", "updated_at": "2022-10-25T17:27:01Z" }, ...... 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_msg": "The resource type vpc:subnet has no permission", "error_code": " RAM .1009" } 其中，error_code表示错误码，error_msg表示错误描述信息。

资源访问管理 RAM
资源访问管理 RAM-返回结果:响应消息头

响应消息头对应请求消息头，响应同样也有消息头，如“Content-type”。详细的公共响应消息头字段请参见表1。表1 公共响应消息头消息头名称描述 Content-Type 资源内容的类型。类型：String 默认值：无。 Connection 指明与服务器的连接是长连接还是短连接。类型：String 有效值：keep-alive | close。默认值：无。 Date RAM服务响应的时间。类型：String 默认值：无。 X-Request-Id 由RAM创建来唯一确定本次请求的值，可以通过该值来定位问题。类型：String 默认值：无。

资源访问管理 RAM
资源访问管理 RAM-拒绝共享邀请:响应参数

响应参数状态码： 200 表3 响应Body参数参数参数类型描述 resource_share_invitation ResourceShareInvitation object 资源共享邀请的详细信息。表4 ResourceShareInvitation 参数参数类型描述 receiver_account_id String 接收资源共享邀请的账号ID。 resource_share_id String 资源共享实例的ID。 resource_share_name String 资源共享实例的名称。 resource_share_invitation_id String 资源共享邀请的ID。 sender_account_id String 发送资源共享邀请的账号ID。 status String 资源共享邀请的当前状态。 created_at String 创建邀请的时间。 updated_at String 最后一次更新邀请的时间。

资源访问管理 RAM
资源访问管理 RAM-拒绝共享邀请:响应示例

响应示例状态码： 200 请求成功。 { "resource_share_invitation" : { "receiver_account_id" : "string", "resource_share_id" : "string", "resource_share_name" : "string", "resource_share_invitation_id" : "string", "sender_account_id" : "string", "status" : "string", "created_at" : "2022-08-22T12:29:00.460Z", "updated_at" : "2022-08-22T12:29:00.460Z" } }

资源访问管理 RAM
资源访问管理 RAM-创建资源共享实例:请求参数

请求参数表1 请求Header参数参数是否必选参数类型描述 X-Security-Token 否 String 如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。表2 请求Body参数参数是否必选参数类型描述 name 是 String 资源共享实例的名称。 description 否 String 资源共享实例的描述。 allow_external_principals 否 Boolean 资源共享实例是否支持共享给组织外账号。 permission_ids 否 Array of strings 资源共享实例关联的RAM权限列表。一种资源类型只能关联一个RAM权限。如果您没有指定权限ID，RAM将自动为每个资源类型关联默认权限。 principals 否 Array of strings 资源共享实例关联的一个或多个资源使用者的列表。 resource_urns 否 Array of strings 资源共享实例关联的一个或多个共享资源URN的列表。 tags 否 Array of Tag objects 资源共享标签列表。表3 Tag 参数是否必选参数类型描述 key 是 String 标签"键"的标识符或名称。 value 是 String 标签"键"对应的"值"。您可以将标签的值设置为空字符串，但不能设置为null。

资源访问管理 RAM
资源访问管理 RAM-创建资源共享实例:响应参数

响应参数状态码： 201 表4 响应Body参数参数参数类型描述 resource_share ResourceShare object 描述RAM中的资源共享。表5 ResourceShare 参数参数类型描述 id String 资源共享实例的ID。 name String 资源共享实例的名称。 description String 资源共享实例的描述。 allow_external_principals Boolean 资源共享实例是否支持共享给组织外账号。 owning_account_id String 资源共享实例的所有者ID。 status String 资源共享实例的状态。 tags Array of Tag objects 资源共享实例的标签列表。 created_at String 创建资源共享实例的时间。 updated_at String 最后一次更新资源共享实例的时间。表6 Tag 参数参数类型描述 key String 标签"键"的标识符或名称。 value String 标签"键"对应的"值"。您可以将标签的值设置为空字符串，但不能设置为null。

资源访问管理 RAM
资源访问管理 RAM-创建资源共享实例:响应示例

响应示例状态码： 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" } }

资源访问管理 RAM
资源访问管理 RAM-创建资源共享实例:请求示例

请求示例创建一个资源共享实例，并指定需要共享的资源，资源使用者，授予资源使用者的权限，以及资源共享实例的标签。 POST https://{endpoint}/v1/resource-shares { "name" : "string", "description" : "string", "permission_ids" : [ "string" ], "principals" : [ "string" ], "resource_urns" : [ "string" ], "tags" : [ { "key" : "string", "value" : "string" } ] }

资源访问管理 RAM
资源访问管理 RAM-检索绑定的共享资源权限:响应示例

响应示例状态码： 200 请求成功。 { "associated_permissions" : [ { "permission_id" : "string", "permission_name" : "string", "resource_type" : "string", "status" : "string", "created_at" : "2022-09-19T02:12:30.736Z", "updated_at" : "2022-09-19T02:12:30.736Z" } ], "page_info" : { "previous_marker" : "string", "next_marker" : "string", "current_count" : 2000 } }

资源访问管理 RAM
资源访问管理 RAM-检索绑定的共享资源权限:URI

URI GET https://{endpoint}/v1/resource-shares/{resource_share_id}/associated-permissions 表1 路径参数参数是否必选参数类型描述 resource_share_id 是 String 资源共享实例的ID。表2 Query参数参数是否必选参数类型描述 permission_name 否 String 共享资源权限的名称。 limit 否 Integer 分页页面的最大值。 marker 否 String 页面标记。

资源访问管理 RAM
资源访问管理 RAM-检索绑定的共享资源权限:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 associated_permissions Array of AssociatedPermission objects 资源共享实例关联的共享资源权限信息列表。 page_info PageInfo object 分页详细信息。表5 AssociatedPermission 参数参数类型描述 permission_id String 权限的ID。 permission_name String 共享资源权限的名称。 resource_type String 权限适用的资源类型。 status String 权限的当前状态。 created_at String 创建权限的时间。 updated_at String 最后一次更新权限的时间。表6 PageInfo 参数参数类型描述 previous_marker String 上一页的页面标识。 next_marker String 下一页的页面标识。 current_count Integer 页面数量。

资源访问管理 RAM
资源访问管理 RAM-更新资源共享实例:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 resource_share ResourceShare object 描述RAM中的资源共享。表5 ResourceShare 参数参数类型描述 id String 资源共享实例的ID。 name String 资源共享实例的名称。 description String 资源共享实例的描述。 allow_external_principals Boolean 资源共享实例是否支持共享给组织外账号。 owning_account_id String 资源共享实例的所有者ID。 status String 资源共享实例的状态。 tags Array of Tag objects 资源共享实例的标签列表。 created_at String 创建资源共享实例的时间。 updated_at String 最后一次更新资源共享实例的时间。表6 Tag 参数参数类型描述 key String 标签"键"的标识符或名称。 value String 标签"键"对应的"值"。您可以将标签的值设置为空字符串，但不能设置为null。

资源访问管理 RAM 资源共享实例
资源访问管理 RAM-更新资源共享实例:响应示例

响应示例状态码： 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" } }

资源访问管理 RAM 资源共享实例
资源访问管理 RAM-更新资源共享实例:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 X-Security-Token 否 String 如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。表3 请求Body参数参数是否必选参数类型描述 name 是 String 资源共享实例的名称。 description 否 String 资源共享实例的描述。 allow_external_principals 否 Boolean 资源共享实例是否支持共享给组织外账号。

资源访问管理 RAM 资源共享实例
资源访问管理 RAM-获取权限的所有版本:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 permissions Array of PermissionSummary objects 共享资源权限的详细信息列表。 page_info PageInfo object 分页详细信息。表5 PermissionSummary 参数参数类型描述 id String 权限ID。 name String 权限名称。 resource_type String 此权限适用的资源类型。 is_resource_type_default Boolean 该权限是否是此资源类型的默认权限。 created_at String 权限的创建时间。 updated_at String 上次更新权限的时间。 permission_urn String 权限URN。 permission_type String 权限类型，RAM托管或者租户自定义权限。 default_version Boolean 是否是默认版本。 version Integer 权限版本。 status String 权限的状态表6 PageInfo 参数参数类型描述 previous_marker String 上一页的页面标识。 next_marker String 下一页的页面标识。 current_count Integer 页面数量。

资源访问管理 RAM 共享资源权限
资源访问管理 RAM-获取权限的所有版本:响应示例

响应示例状态码： 200 请求成功。 { "permissions" : [ { "id" : "string", "name" : "string", "resource_type" : "string", "is_resource_type_default" : true, "created_at" : "2022-09-19T02:02:18.155Z", "updated_at" : "2022-09-19T02:02:18.155Z", "permission_urn" : "string", "permission_type" : "string", "default_version" : false, "version" : 1, "status" : "string" } ], "page_info" : { "previous_marker" : "string", "next_marker" : "string", "current_count" : 2000 } }

资源访问管理 RAM 共享资源权限
资源访问管理 RAM-获取权限的所有版本:URI

URI GET https://{endpoint}//v1/permissions/{permission_id}/versions 表1 路径参数参数是否必选参数类型描述 permission_id 是 String 共享资源权限的ID。表2 Query参数参数是否必选参数类型描述 limit 否 Integer 分页页面的最大值。 marker 否 String 页面标记。

资源访问管理 RAM 共享资源权限
资源访问管理 RAM-构造请求:请求消息头

请求消息头附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。详细的公共请求消息头字段请参见表3。如下公共消息头需要添加到请求中。表3 公共请求消息头消息头名称描述是否必选 Authorization 请求消息中可带的签名信息。AK/SK认证的详细说明请参见：AK/SK认证。类型：String 默认值：无。是 Content-Type 资源内容的类型，例如：application/json。类型：String 默认值：无。是 X-Sdk-Date 请求发起端的日期和时间，例如：20221107T020014Z。类型：String 默认值：无。是 Host 表明主机地址。例如：ram.myhuaweicloud.com。类型：String 默认值：无。是 API支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。AK/SK认证的详细说明请参见：AK/SK认证。对于检索共享资源权限列表接口，请求如下所示。 GET https://ram.myhuaweicloud.com/v1/permissions content-type: application/json X-Sdk-Date: 20230330T021902Z host: ram.myhuaweicloud.com Authorization: SDK-HMAC-SHA256 Access=xxxxxxxxxxxxxxxxxxx, SignedHeaders=content-type;host;x-sdk-date, Signature=xxxxxxxxxxxxxxxxxxxx

资源访问管理 RAM 如何调用API
资源访问管理 RAM-构造请求:请求URI

请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 表1 请求URL 参数说明 URI-scheme 传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 承载REST服务端点的服务器域名或IP，不同服务在不同区域，Endpoint不同，可以从地区和终端节点处获取。例如RAM服务的Endpoint为ram.myhuaweicloud.com。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取，例如“检索指定资源类型的共享资源权限列表”API的resource-path为“/v1/permissions”。 query-string 查询参数，可选，查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“?limit=10”，表示查询不超过10条数据。例如您需要检索指定资源类型的共享资源权限列表，则需使用RAM的Endpoint（ram.myhuaweicloud.com），并在检索共享资源权限列表的URI部分找到resource-path（/v1/permissions），拼接起来如下所示。 https://ram.myhuaweicloud.com/v1/permissions

资源访问管理 RAM 如何调用API
资源访问管理 RAM-绑定资源使用者和共享资源:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 resource_share_associations Array of ResourceShareAssociation objects 与资源共享实例关联的资源使用者或共享资源的详细信息。表5 ResourceShareAssociation 参数参数类型描述 associated_entity String 绑定的实体。这可以是共享资源的URN、账号ID、组织根的URN或OU的URN之一。 association_type String 绑定中包含的实体类型。 created_at String 绑定被创建的时间。 updated_at String 最后一次更新绑定的时间。 external Boolean 标识资源使用者是否和共享的拥有者属于同一个组织 resource_share_id String 资源共享实例的ID。 resource_share_name String 资源共享实例的名称。 status String 绑定的当前状态。 status_message String 绑定的当前状态的描述。

资源访问管理 RAM
资源访问管理 RAM-绑定资源使用者和共享资源:响应示例

响应示例状态码： 200 请求成功。 { "resource_share_associations" : [ { "associated_entity" : "string", "association_type" : "string", "created_at" : "2022-08-22T11:50:25.639Z", "updated_at" : "2022-08-22T11:50:25.639Z", "external" : true, "resource_share_id" : "string", "resource_share_name" : "string", "status" : "string", "status_message" : "string" } ] }

资源访问管理 RAM
资源访问管理 RAM-绑定资源使用者和共享资源:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 X-Security-Token 否 String 如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。表3 请求Body参数参数是否必选参数类型描述 principals 否 Array of strings 指定与资源共享实例关联的一个或多个资源使用者的列表。 resource_urns 否 Array of strings 指定与资源共享实例关联的一个或多个共享资源URN的列表。

资源访问管理 RAM
资源访问管理 RAM-检索绑定的资源使用者和共享资源:响应示例

响应示例状态码： 200 请求成功。 { "resource_share_associations" : [ { "associated_entity" : "string", "association_type" : "string", "created_at" : "2022-09-19T02:10:16.960Z", "updated_at" : "2022-09-19T02:10:16.960Z", "external" : true, "resource_share_id" : "string", "resource_share_name" : "string", "status" : "string", "status_message" : "string" } ], "page_info" : { "previous_marker" : "string", "next_marker" : "string", "current_count" : 2000 } }

资源访问管理 RAM
资源访问管理 RAM-检索绑定的资源使用者和共享资源:请求参数

请求参数表1 请求Header参数参数是否必选参数类型描述 X-Security-Token 否 String 如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。表2 请求Body参数参数是否必选参数类型描述 association_status 否 String 指定绑定的状态。 association_type 是 String 指定绑定的类型（principal或resource）。 limit 否 Integer 分页页面的最大值。 marker 否 String 页面标记。 principal 否 String 指定绑定的资源使用者。 resource_urn 否 String 指定绑定的共享资源URN。 resource_share_ids 否 Array of strings 指定资源共享实例的ID列表。 resource_ids 否 Array of strings 指定共享资源ID列表。

资源访问管理 RAM
资源访问管理 RAM-检索绑定的资源使用者和共享资源:响应参数

响应参数状态码： 200 表3 响应Body参数参数参数类型描述 resource_share_associations Array of ResourceShareAssociation objects 绑定的详细信息列表。 page_info PageInfo object 分页详细信息。表4 ResourceShareAssociation 参数参数类型描述 associated_entity String 绑定的实体。这可以是共享资源的URN、账号ID、组织根的URN或OU的URN之一。 association_type String 绑定中包含的实体类型。 created_at String 绑定被创建的时间。 updated_at String 最后一次更新绑定的时间。 external Boolean 标识资源使用者是否和共享的拥有者属于同一个组织 resource_share_id String 资源共享实例的ID。 resource_share_name String 资源共享实例的名称。 status String 绑定的当前状态。 status_message String 绑定的当前状态的描述。表5 PageInfo 参数参数类型描述 previous_marker String 上一页的页面标识。 next_marker String 下一页的页面标识。 current_count Integer 页面数量。

资源访问管理 RAM
资源访问管理 RAM-检索绑定的资源使用者和共享资源:请求示例

请求示例检索您拥有的资源共享实例中绑定的共享资源和资源使用者。 POST https://{endpoint}/v1/resource-share-associations/search { "association_status" : "string", "association_type" : "principal", "limit" : 2000, "marker" : "string", "principal" : "string", "resource_urn" : "string", "resource_share_ids" : [ "string" ], "resource_ids" : [ "string" ] }

资源访问管理 RAM
资源访问管理 RAM-检索资源使用者:响应参数

响应参数状态码： 200 表3 响应Body参数参数参数类型描述 shared_principals Array of SharedPrincipal objects 资源使用者的详细信息列表。 page_info PageInfo object 分页详细信息。表4 SharedPrincipal 参数参数类型描述 resource_share_id String 资源使用者绑定的资源共享实例的ID。 id String 资源使用者的账号ID或URN。 created_at String 资源使用者与资源共享实例关联的时间。 updated_at String 最后一次更新资源共享实例的时间。表5 PageInfo 参数参数类型描述 previous_marker String 上一页的页面标识。 next_marker String 下一页的页面标识。 current_count Integer 页面数量。

资源访问管理 RAM 资源使用者
资源访问管理 RAM-检索资源使用者:请求示例

请求示例检索共享资源的使用者。 POST https://{endpoint}/v1/shared-principals/search { "limit" : 2000, "marker" : "string", "principals" : [ "string" ], "resource_urn" : "string", "resource_owner" : "self", "resource_share_ids" : [ "string" ] }

资源访问管理 RAM 资源使用者
资源访问管理 RAM-检索资源使用者:响应示例

响应示例状态码： 200 请求成功。 { "shared_principals" : [ { "resource_share_id" : "string", "id" : "string", "created_at" : "2022-09-19T02:33:13.496Z", "updated_at" : "2022-09-19T02:33:13.496Z" } ], "page_info" : { "previous_marker" : "string", "next_marker" : "string", "current_count" : 2000 } }

资源访问管理 RAM 资源使用者
资源访问管理 RAM-检索资源使用者:请求参数

请求参数表1 请求Header参数参数是否必选参数类型描述 X-Security-Token 否 String 如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。表2 请求Body参数参数是否必选参数类型描述 limit 否 Integer 分页页面的最大值。 marker 否 String 页面标记。 principals 否 Array of strings 指定资源使用者。 resource_urn 否 String 指定资源的URN。 resource_owner 是 String 指定资源共享实例的所有者（self或者other-accounts）。 resource_share_ids 否 Array of strings 指定资源共享实例的ID列表。

资源访问管理 RAM 资源使用者

共100000条

undefined

意见反馈

0/200

提交取消

提交成功！非常感谢您的反馈，我们会继续努力做到更好反馈提交失败！请稍后重试！

华为云用户手册

7*24

备案

专业服务

退订

建议反馈

售前咨询热线