华为云用户手册

  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 resource_share_invitation ResourceShareInvitation object 资源共享邀请的详细信息。 表4 ResourceShareInvitation 参数 参数类型 描述 receiver_account_id String 接收资源共享邀请的帐号ID。 最小长度:0 最大长度:36 resource_share_id String 资源共享实例的ID。 最小长度:0 最大长度:36 resource_share_name String 资源共享实例的名称。 最小长度:0 最大长度:64 resource_share_invitation_id String 资源共享邀请的ID。 最小长度:0 最大长度:36 sender_account_id String 发送资源共享邀请的帐号ID。 最小长度:0 最大长度:36 status String 资源共享邀请的当前状态。 最小长度:0 最大长度:64 created_at String 创建邀请的时间。 updated_at String 最后一次更新邀请的时间。
  • 响应示例 状态码: 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" }}
  • 响应示例 状态码: 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" } ], "page_info" : { "previous_marker" : "string", "next_marker" : "string", "current_count" : 2000 }}
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 最小长度:0 最大长度:2048 表2 请求Body参数 参数 是否必选 参数类型 描述 association_status 否 String 指定绑定的状态。 最小长度:0 最大长度:64 association_type 是 String 指定绑定的类型(principal或resource)。 枚举值: principal resource limit 否 Integer 分页页面的最大值。 最小值:1 最大值:2000 marker 否 String 页面标记。 最小长度:1 最大长度:64 principal 否 String 指定绑定的资源使用者。 最小长度:0 最大长度:1024 resource_urn 否 String 指定绑定的共享资源URN。 最小长度:0 最大长度:1024 resource_share_ids 否 Array of strings 指定资源共享实例的ID列表。 最小长度:0 最大长度:36 resource_ids 否 Array of strings 指定共享资源ID列表。 最小长度:1 最大长度:512
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 resource_share_associations Array of ResourceShareAssociation objects 绑定的详细信息列表。 page_info PageInfo object 分页详细信息。 表4 ResourceShareAssociation 参数 参数类型 描述 associated_entity String 绑定的实体。这可以是共享资源的URN、帐号ID、共享资源目录的URN或文件夹的URN之一。 最小长度:0 最大长度:1500 association_type String 绑定中包含的实体类型。 最小长度:0 最大长度:36 created_at String 绑定被创建的时间。 updated_at String 最后一次更新绑定的时间。 external Boolean 标识资源使用者是否和共享的拥有者属于同一个组织 resource_share_id String 资源共享实例的ID。 最小长度:0 最大长度:36 resource_share_name String 资源共享实例的名称。 最小长度:0 最大长度:64 status String 绑定的当前状态。 最小长度:0 最大长度:36 表5 PageInfo 参数 参数类型 描述 previous_marker String 上一页的页面标识。 最小长度:1 最大长度:64 next_marker String 下一页的页面标识。 最小长度:1 最大长度:64 current_count Integer 页面数量。 最小值:1 最大值:2000
  • 请求示例 { "association_status" : "string", "association_type" : "principal", "limit" : 2000, "marker" : "string", "principal" : "string", "resource_urn" : "string", "resource_share_ids" : [ "string" ], "resource_ids" : [ "string" ]}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 最小长度:0 最大长度:2048 表3 请求Body参数 参数 是否必选 参数类型 描述 without_any_tag 否 Boolean 不包含任意一个标签,该字段为true时查询所有不带标签的资源。 tags 否 Array of TagFilter objects 包含标签,最多包含20个key,每个key下面的value最多20个,结构体不能缺失,key不能为空或者空字符串。Key不能重复,同一个key中values不能重复。返回包含所有标签的资源列表,key之间是"与"的关系,key-value结构中value是"或"的关系。无tag过滤条件时返回全量数据。 matches 否 Array of Match objects 资源共享实例绑定标签列表的匹配字段。 表4 TagFilter 参数 是否必选 参数类型 描述 key 是 String 标签"键"的标识符或名称。 最小长度:1 最大长度:128 values 否 Array of strings 标签"键"对应的"值"列表。 最小长度:0 最大长度:255 表5 Match 参数 是否必选 参数类型 描述 key 是 String 键。取值范围为policy , organizational-unit, account。 最小长度:0 最大长度:128 value 是 String 值。每个值最大长度255个字符。 最小长度:0 最大长度:255
  • 响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 resources Array of ResourceDTO objects 资源信息列表。 total_count Integer 总记录数。 表7 ResourceDTO 参数 参数类型 描述 resource_id String 资源ID。 resource_name String 资源名称。 tags Array of Tag objects 资源标签列表。 resource_detail Object 资源详情。 表8 Tag 参数 参数类型 描述 key String 标签"键"的标识符或名称。 最小长度:1 最大长度:128 value String 标签"键"对应的"值"。您可以将标签的值设置为空字符串,但不能设置为null。 最小长度:0 最大长度:255
  • 响应示例 状态码: 200 Successful { "resources" : [ { "resource_id" : "string", "resource_name" : "string", "resource_detail" : { }, "tags" : [ { "key" : "string", "value" : "string" } ] } ], "total_count" : 0}
  • 请求消息头 附加请求头字段,如指定的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/jsonX-Sdk-Date: 20230330T021902Z host: ram.myhuaweicloud.com Authorization: SDK-HMAC-SHA256 Access=xxxxxxxxxxxxxxxxxxx, SignedHeaders=content-type;host;x-sdk-date, Signature=xxxxxxxxxxxxxxxxxxxx
  • 请求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
  • 支持的授权项 策略包含系统策略和自定义策略,如果系统策略不满足授权要求,管理员可以创建自定义策略,并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应,授权项列表说明如下: 权限:允许或拒绝某项操作。 对应API接口:自定义策略实际调用的API接口。 授权项:自定义策略中支持的Action,在自定义策略中的Action中写入授权项,可以实现授权项对应的权限功能。 依赖的授权项:部分Action存在对其他Action的依赖,需要将依赖的Action同时写入授权项,才能实现对应的权限功能。 IAM 项目(Project)/企业项目(Enterprise Project):自定义策略的授权范围,包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目,表示此授权项对应的自定义策略,可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目,不支持企业项目,表示仅能在IAM中给用户组授权并生效,如果在企业管理中授权,则该自定义策略不生效。关于IAM项目与企业项目的区别,详情请参见:IAM项目与企业项目的区别。 “√”表示支持,“x”表示暂不支持。
  • 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 详细的公共响应消息头字段请参见表1。 表1 公共响应消息头 消息头名称 描述 Content-Type 资源内容的类型。 类型:String 默认值:无。 Connection 指明与服务器的连接是长连接还是短连接。 类型:String 有效值:keep-alive | close。 默认值:无。 Date RAM服务响应的时间。 类型:String 默认值:无。 X-Request-Id 由RAM创建来唯一确定本次请求的值,可以通过该值来定位问题。 类型:String 默认值:无。
  • 响应消息体 响应消息体通常以结构化格式返回,与响应消息头中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:subnets has no permission", "error_code": "RAM.1009"} 其中,error_code表示错误码,error_msg表示错误描述信息。
  • 获取帐号、IAM用户、项目的名称和ID 从控制台获取帐号名、帐号ID、用户名、用户ID、项目名称、项目ID 在华为云首页右上角,点击“控制台”。 在右上角的用户名中选择“我的凭证”。 图1 进入我的凭证 在“我的凭证”界面,API凭证页签中,查看帐号名、帐号ID、用户名、用户ID、项目名称、项目ID。 每个区域的项目ID有所不同,需要根据业务所在的区域获取对应的项目ID。 图2 查看帐号名、帐号ID、用户名、用户ID、项目名称、项目ID 调用API获取用户ID、项目ID 获取用户ID请参考:管理员查询IAM用户列表。 获取项目ID请参考:查询指定条件下的项目列表。
  • 请求示例 { "limit" : 2000, "name" : "string", "marker" : "string", "permission_id" : "string", "resource_owner" : "self", "resource_share_ids" : [ "string" ], "resource_share_status" : "string", "tag_filters" : [ { "key" : "string", "values" : [ "string" ] } ]}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 resource_shares Array of ResourceShare objects 资源共享实例的详细信息列表。 page_info PageInfo object 分页详细信息。 表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 资源共享实例的标签列表。 created_at String 创建资源共享实例的时间。 updated_at String 最后一次更新资源共享实例的时间。 表6 Tag 参数 参数类型 描述 key String 标签"键"的标识符或名称。 最小长度:1 最大长度:128 value String 标签"键"对应的"值"。您可以将标签的值设置为空字符串,但不能设置为null。 最小长度:0 最大长度:255 表7 PageInfo 参数 参数类型 描述 previous_marker String 上一页的页面标识。 最小长度:1 最大长度:64 next_marker String 下一页的页面标识。 最小长度:1 最大长度:64 current_count Integer 页面数量。 最小值:1 最大值:2000
  • 响应示例 状态码: 200 请求成功。 { "resource_shares" : [ { "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-06T08:24:55.638Z", "updated_at" : "2023-01-06T08:24:55.638Z" } ], "page_info" : { "previous_marker" : "string", "next_marker" : "string", "current_count" : 2000 }}
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 最小长度:0 最大长度:2048 表2 请求Body参数 参数 是否必选 参数类型 描述 limit 否 Integer 分页页面的最大值。 最小值:1 最大值:2000 name 否 String 资源共享实例名称。 最小长度:0 最大长度:64 marker 否 String 页面标记。 最小长度:1 最大长度:64 permission_id 否 String 权限ID。 最小长度:0 最大长度:36 resource_owner 是 String 检索您创建的或共享给您的(self或者other-accounts)资源共享实例。 枚举值: self other-accounts resource_share_ids 否 Array of strings 资源共享实例的ID列表。 最小长度:0 最大长度:36 resource_share_status 否 String 资源共享实例的状态。 最小长度:0 最大长度:36 tag_filters 否 Array of TagFilter objects 资源共享实例的标签。 表3 TagFilter 参数 是否必选 参数类型 描述 key 是 String 标签"键"的标识符或名称。 最小长度:1 最大长度:128 values 否 Array of strings 标签"键"对应的"值"列表。 最小长度:0 最大长度:255
  • 响应示例 状态码: 200 请求成功。 { "resource_share_associations" : [ { "associated_entity" : "string", "association_type" : "string", "created_at" : "2022-08-22T11:53:04.912Z", "updated_at" : "2022-08-22T11:53:04.912Z", "external" : true, "resource_share_id" : "string", "resource_share_name" : "string", "status" : "string" } ]}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 最小长度:0 最大长度:2048 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 是 Array of Untag objects 一个或多个标签键值对的列表。标签键必须存在,而不是空字符串。标签值必须存在,但可以是空字符串。 表4 Untag 参数 是否必选 参数类型 描述 key 是 String 标签"键"的标识符或名称。 最小长度:1 最大长度:128 value 否 String 标签"键"对应的"值"。您可以将标签的值设置为空字符串,但不能设置为null。 最小长度:0 最大长度:255
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 最小长度:0 最大长度:2048 表3 请求Body参数 参数 是否必选 参数类型 描述 principals 否 Array of strings 指定与资源共享实例关联的一个或多个资源使用者的列表。 最小长度:0 最大长度:1024 resource_urns 否 Array of strings 指定与资源共享实例关联的一个或多个共享资源URN的列表。 最小长度:0 最大长度:1024
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 resource_share_associations Array of ResourceShareAssociation objects 与资源共享实例关联的资源使用者或共享资源的详细信息。 表5 ResourceShareAssociation 参数 参数类型 描述 associated_entity String 绑定的实体。这可以是共享资源的URN、帐号ID、共享资源目录的URN或文件夹的URN之一。 最小长度:0 最大长度:1500 association_type String 绑定中包含的实体类型。 最小长度:0 最大长度:36 created_at String 绑定被创建的时间。 updated_at String 最后一次更新绑定的时间。 external Boolean 标识资源使用者是否和共享的拥有者属于同一个组织 resource_share_id String 资源共享实例的ID。 最小长度:0 最大长度:36 resource_share_name String 资源共享实例的名称。 最小长度:0 最大长度:64 status String 绑定的当前状态。 最小长度:0 最大长度:36
  • 响应示例 状态码: 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" }}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 最小长度:0 最大长度:2048 表3 请求Body参数 参数 是否必选 参数类型 描述 permission_id 是 String 共享资源权限的ID。 最小长度:1 最大长度:36
  • 请求示例 { "name" : "string", "description" : "string", "permission_ids" : [ "string" ], "principals" : [ "string" ], "resource_urns" : [ "string" ], "tags" : [ { "key" : "string", "value" : "string" } ]}
  • 响应参数 状态码: 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 资源共享实例的标签列表。 created_at String 创建资源共享实例的时间。 updated_at String 最后一次更新资源共享实例的时间。 表6 Tag 参数 参数类型 描述 key String 标签"键"的标识符或名称。 最小长度:1 最大长度:128 value String 标签"键"对应的"值"。您可以将标签的值设置为空字符串,但不能设置为null。 最小长度:0 最大长度:255
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 最小长度:0 最大长度:2048 表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 principals 否 Array of strings 资源共享实例关联的一个或多个资源使用者的列表。 最小长度:0 最大长度:1024 resource_urns 否 Array of strings 资源共享实例关联的一个或多个共享资源URN的列表。 最小长度:0 最大长度:1024 tags 否 Array of Tag objects 资源共享标签列表。 表3 Tag 参数 是否必选 参数类型 描述 key 是 String 标签"键"的标识符或名称。 最小长度:1 最大长度:128 value 是 String 标签"键"对应的"值"。您可以将标签的值设置为空字符串,但不能设置为null。 最小长度:0 最大长度:255
  • 响应示例 状态码: 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" } ], "page_info" : { "previous_marker" : "string", "next_marker" : "string", "current_count" : 2000 }}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 permissions Array of PermissionSummary objects 共享资源权限的详细信息列表。 page_info PageInfo object 分页详细信息。 表4 PermissionSummary 参数 参数类型 描述 id String 权限ID。 最小长度:0 最大长度:36 name String 权限名称。 最小长度:1 最大长度:128 resource_type String 此权限适用的资源类型。 最小长度:0 最大长度:100 is_resource_type_default Boolean 该权限是否是此资源类型的默认权限。 created_at String 权限的创建时间。 updated_at String 上次更新权限的时间。 表5 PageInfo 参数 参数类型 描述 previous_marker String 上一页的页面标识。 最小长度:1 最大长度:64 next_marker String 下一页的页面标识。 最小长度:1 最大长度:64 current_count Integer 页面数量。 最小值:1 最大值:2000
共100000条