华为云用户手册

  • 响应示例 状态码: 200 Successful { "organization" : { "id" : "o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv", "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:organization:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv", "management_account_id" : "0a6d25d23900d45c0faac010e0fb4de0", "management_account_name" : "paas_iam_573331", "created_at" : "2022-08-24T06:31:46Z" } }
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 organization OrganizationDto object 包含有关组织的详细信息。组织是账号集合,使用合并计费集中管理,由组织单元构成的层次结构,并通过策略控制。 表3 OrganizationDto 参数 参数类型 描述 id String 组织的唯一标识符(ID)。 最大长度:34 urn String 组织的统一资源名称。 最小长度:1 最大长度:1500 management_account_id String 组织管理账号的唯一标识符(ID)。 最大长度:36 management_account_name String 组织的管理账号的名称。 最大长度:64 created_at String 组织的创建时间。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 create_account_status CreateAccountStatusDto object 包含有关在组织中创建账号的CreateAccount请求的状态。 表4 CreateAccountStatusDto 参数 参数类型 描述 account_id String 如果账号创建成功,则为新账号的唯一标识符(ID)。 最大长度:36 account_name String 账号名称。 最大长度:64 completed_at String 创建账号和完成请求的日期和时间。 created_at String 请求创建账号的日期和时间。 id String 请求的唯一标识符(ID)。您可以从创建账号的初始CreateAccount请求的响应中获得此值。 最大长度:36 state String 创建账号的异步请求的状态,in_progress:处理中,succeeded:成功,failed:失败。 最小长度:1 最大长度:64 failure_reason String 如果请求失败,则说明失败原因。
  • 响应示例 状态码: 200 Successful { "create_account_status" : { "account_id" : "0a6d25d23900d45c0faac010e0fb4de0", "account_name" : "paas_iam_573331", "completed_at" : "2022-08-24T06:41:15Z", "created_at" : "2022-08-24T06:41:15Z", "id" : "h-awjp43m7bz3b8jgy5v61jrfwakt3og8w", "state" : "in_progress", "failure_reason" : "string" } }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 tags Array of TagDto objects 标签列表。 page_info PageInfoDto object 分页信息 表5 TagDto 参数 参数类型 描述 key String 标签键的密钥标识符或名称。 最小长度:1 最大长度:128 value String 与标签键关联的字符串值。您可以将标签的值设置为空字符串,但不能将标签的值设置为NULL。 最小长度:0 最大长度:255 表6 PageInfoDto 参数 参数类型 描述 next_marker String 如果存在,则表示可用的输出比当前响应中包含的输出多。在对操作的后续调用中,在标签请求参数中使用此值,以获取输出的下一部分。您应该重复此操作,直到next_marker响应元素返回为null。 current_count Integer 本页返回条目数量 最小值:1 最大值:2000
  • URI GET /v1/organizations/resources/{resource_id}/tags 表1 路径参数 参数 是否必选 参数类型 描述 resource_id 是 String 根、组织单元、账号或策略的唯一标识符(ID)。 最大长度:130 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 页面中最大结果数量。 最小值:1 最大值:2000 缺省值:200 marker 否 String 分页标记。 最小长度:4 最大长度:400
  • 响应示例 状态码: 200 Successful. { "tags" : [ { "key" : "auto09230Uv5key", "value" : "auto0923XXFmvalue" } ], "page_info" : { "next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw", "current_count" : 100 } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 最小值:1 最大长度:2048 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 是 Array of TagDto objects 要添加到指定资源的标签列表。 数组长度:1 - 20 表4 TagDto 参数 是否必选 参数类型 描述 key 是 String 标签键的密钥标识符或名称。 最小长度:1 最大长度:128 value 是 String 与标签键关联的字符串值。您可以将标签的值设置为空字符串,但不能将标签的值设置为NULL。 最小长度:0 最大长度:255
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 最小值:1 最大长度:2048 表2 请求Body参数 参数 是否必选 参数类型 描述 service_principal 是 String 服务主体名称。 最小长度:0 最大长度:100
  • URI GET /v1/organizations/accounts/{account_id}/delegated-services 表1 路径参数 参数 是否必选 参数类型 描述 account_id 是 String 账号的唯一标识符(ID)。 最大长度:36 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 页面中最大结果数量。 最小值:1 最大值:2000 缺省值:200 marker 否 String 分页标记。 最小长度:4 最大长度:400
  • 响应示例 状态码: 200 Successful. { "delegated_services" : [ { "service_principal" : "autoservice0922102321263V58H", "delegation_enabled_at" : "2022-09-22T02:23:21Z" } ], "page_info" : { "next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw", "current_count" : 100 } }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 delegated_services Array of DelegatedServiceDto objects 账号是其委托管理员的服务。 page_info PageInfoDto object 分页信息 表5 DelegatedServiceDto 参数 参数类型 描述 service_principal String 服务主体的名称。 最小长度:1 最大长度:100 delegation_enabled_at String 账号成为此服务的委托管理员的日期。 表6 PageInfoDto 参数 参数类型 描述 next_marker String 如果存在,则表示可用的输出比当前响应中包含的输出多。在对操作的后续调用中,在标签请求参数中使用此值,以获取输出的下一部分。您应该重复此操作,直到next_marker响应元素返回为null。 current_count Integer 本页返回条目数量 最小值:1 最大值:2000
  • 响应参数 状态码: 202 表3 响应Body参数 参数 参数类型 描述 root RootDto object 包含根的详细信息。根是组织层次结构中的顶级父节点,可以包含组织单元和账号。 表4 RootDto 参数 参数类型 描述 id String 根的唯一标识符(ID)。 最小长度:1 最大长度:34 urn String 根的统一资源名称。 最小长度:1 最大长度:1500 name String 根的名称。 最小长度:1 最大长度:64 policy_types Array of PolicyTypeSummaryDto objects 策略类型在当前根已启用,则该类型策略可以绑定到根或其组织单元或账号。 created_at String 根的创建时间。 表5 PolicyTypeSummaryDto 参数 参数类型 描述 status String 与根关联的策略类型状态。要将指定类型的策略绑定到根或该根中的组织单元或账号,该策略必须在组织中可用,并在该根已启用。enabled:启用;pending_enable:启用中;disabled:禁用;pending_disable:禁用中。 最小长度:1 最大长度:64 type String 策略类型的名称,service_control_policy:服务控制策略;tag_policy:标签策略。 最小长度:1 最大长度:64
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 最小值:1 最大长度:2048 表2 请求Body参数 参数 是否必选 参数类型 描述 policy_type 是 String 策略类型的名称,service_control_policy服务控制策略;tag_policy:标签策略。 枚举值: service_control_policy tag_policy root_id 是 String 根的唯一标识符(ID)。 最大长度:34
  • 响应示例 状态码: 202 Successful. { "root" : { "id" : "05261f923e80d3890f33c0056e9b3f80", "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:policy:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/service_control_policy/p-b4wpejd02o66g0pvfinvsatp4t9krfum", "name" : "paas_iam_573331", "policy_types" : [ { "status" : "enabled", "type" : "service_control_policy" } ], "created_at" : "2022-09-22T02:23:21Z" } }
  • 响应示例 状态码: 202 Successful. { "root" : { "id" : "05261f923e80d3890f33c0056e9b3f80", "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:policy:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/service_control_policy/p-b4wpejd02o66g0pvfinvsatp4t9krfum", "name" : "paas_iam_573331", "policy_types" : [ { "status" : "enabled", "type" : "service_control_policy" } ], "created_at" : "2022-09-22T02:23:21Z" } }
  • 响应参数 状态码: 202 表3 响应Body参数 参数 参数类型 描述 root RootDto object 包含根的详细信息。根是组织层次结构中的顶级父节点,可以包含组织单元和账号。 表4 RootDto 参数 参数类型 描述 id String 根的唯一标识符(ID)。 最小长度:1 最大长度:34 urn String 根的统一资源名称。 最小长度:1 最大长度:1500 name String 根的名称。 最小长度:1 最大长度:64 policy_types Array of PolicyTypeSummaryDto objects 策略类型在当前根已启用,则该类型策略可以绑定到根或其组织单元或账号。 created_at String 根的创建时间。 表5 PolicyTypeSummaryDto 参数 参数类型 描述 status String 与根关联的策略类型状态。要将指定类型的策略绑定到根或该根中的组织单元或账号,该策略必须在组织中可用,并在该根已启用。enabled:启用;pending_enable:启用中;disabled:禁用;pending_disable:禁用中。 最小长度:1 最大长度:64 type String 策略类型的名称,service_control_policy:服务控制策略;tag_policy:标签策略。 最小长度:1 最大长度:64
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 最小值:1 最大长度:2048 表2 请求Body参数 参数 是否必选 参数类型 描述 policy_type 是 String 策略类型的名称,service_control_policy服务控制策略;tag_policy:标签策略。 枚举值: service_control_policy tag_policy root_id 是 String 根的唯一标识符(ID)。 最大长度:34
  • 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。 GET:请求服务器返回指定资源。 PUT:请求服务器更新指定资源。 POST:请求服务器新增资源或执行特殊操作。 DELETE:请求服务器删除指定资源,如删除对象等。 HEAD:请求服务器资源头部。 PATCH:请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。 在查询所属组织信息的URI部分,您可以看到其请求方法为“GET”,则其请求为: GET https://organizations.myhuaweicloud.com/v1/organizations
  • 请求消息头 附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type:消息体的类型(格式),必选,默认取值为“application/json”。 Authorization:请求消息中可带的签名信息,必选,AK/SK认证的详细说明请参见:AK/SK认证。 X-Sdk-Date:请求发送的时间,必选, 例如:20221107T020014Z。 Host: 表明主机地址, 必选 , 如organizations.myhuaweicloud.com。 API支持使用AK/SK认证,AK/SK认证是使用SDK对请求进行签名,签名过程会自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求头。AK/SK认证的详细说明请参见:AK/SK认证。 对于查询所属组织信息接口,请求如下所示。 GET https://organizations.myhuaweicloud.com/v1/organizations content-type: application/json X-Sdk-Date: 20230330T021902Z host: organizations.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不同,可以从使用前必读中获取。例如Organizations服务的Endpoint为organizations.myhuaweicloud.com。 resource-path 资源路径,即API访问路径。从具体API的URI模块获取,例如查询所属组织信息API的resource-path为“/v1/organizations”。 query-string 查询参数,可选,查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?limit=10”,表示查询不超过10条数据。 例如您需要查询所属组织信息,则需使用Organizations的Endpoint(organizations.myhuaweicloud.com),并在查询所属组织信息的URI部分找到resource-path(/v1/organizations),拼接起来如下所示。 1 https://organizations.myhuaweicloud.com/v1/organizations 为查看方便,每个具体API的URI,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
  • 响应示例 状态码: 200 Successful. { "roots" : { "id" : "r-rpjghpbmumu2hffplsj5edt1z3vybb94", "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:root:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/r-rpjghpbmumu2hffplsj5edt1z3vybb94", "name" : "root", "policy_types" : [ { "status" : "enabled", "type" : "service_control_policy" } ], "created_at" : "2022-08-24T06:31:46Z" }, "page_info" : { "next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw", "current_count" : 100 } }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 roots Array of RootDto objects 在组织中定义的根列表。 page_info PageInfoDto object 分页信息 表4 RootDto 参数 参数类型 描述 id String 根的唯一标识符(ID)。 最小长度:1 最大长度:34 urn String 根的统一资源名称。 最小长度:1 最大长度:1500 name String 根的名称。 最小长度:1 最大长度:64 policy_types Array of PolicyTypeSummaryDto objects 策略类型在当前根已启用,则该类型策略可以绑定到根或其组织单元或账号。 created_at String 根的创建时间。 表5 PolicyTypeSummaryDto 参数 参数类型 描述 status String 与根关联的策略类型状态。要将指定类型的策略绑定到根或该根中的组织单元或账号,该策略必须在组织中可用,并在该根已启用。enabled:启用;pending_enable:启用中;disabled:禁用;pending_disable:禁用中。 最小长度:1 最大长度:64 type String 策略类型的名称,service_control_policy:服务控制策略;tag_policy:标签策略。 最小长度:1 最大长度:64 表6 PageInfoDto 参数 参数类型 描述 next_marker String 如果存在,则表示可用的输出比当前响应中包含的输出多。在对操作的后续调用中,在标签请求参数中使用此值,以获取输出的下一部分。您应该重复此操作,直到next_marker响应元素返回为null。 current_count Integer 本页返回条目数量 最小值:1 最大值:2000
  • 支持的授权项 策略包含系统策略和自定义策略,如果系统策略不满足授权要求,管理员可以创建自定义策略,并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应,授权项列表说明如下: 权限:允许或拒绝对指定资源在特定条件下进行某项操作。 对应API接口:自定义策略实际调用的API接口。 授权项:自定义策略中支持的Action,在自定义策略中的Action中写入授权项,可以实现授权项对应的权限功能。 依赖的授权项:部分Action存在对其他Action的依赖,需要将依赖的Action同时写入授权项,才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project):自定义策略的授权范围,包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目,表示此授权项对应的自定义策略,可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目,不支持企业项目,表示仅能在IAM中给用户组授权并生效,如果在企业管理中授权,则该自定义策略不生效。管理员可以在授权项列表中查看授权项是否支持IAM项目或企业项目,“√”表示支持,“×”表示暂不支持。关于IAM项目与企业项目的区别,详情请参见:IAM与企业管理的区别。
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 最小值:1 最大长度:2048 表2 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 要分配给新组织单元的名称。 最小长度:1 最大长度:64 parent_id 是 String 要在其中创建新组织单元的根或组织单元的唯一标识符。 最大长度:100 tags 否 Array of TagDto objects 要附加到新创建的组织单元的标签列表。 表3 TagDto 参数 是否必选 参数类型 描述 key 是 String 标签键的密钥标识符或名称。 最小长度:1 最大长度:128 value 是 String 与标签键关联的字符串值。您可以将标签的值设置为空字符串,但不能将标签的值设置为NULL。 最小长度:0 最大长度:255
  • 响应参数 状态码: 201 表4 响应Body参数 参数 参数类型 描述 organizational_unit OrganizationalUnitDto object 包含有关新创建的组织单元的详细信息的结构。 表5 OrganizationalUnitDto 参数 参数类型 描述 id String 与组织单元关联的唯一标识符(ID)。 最小长度:1 最大长度:35 urn String 组织单元的统一资源名称。 最小长度:1 最大长度:1500 name String 组织单元的名称。 最小长度:1 最大长度:64 created_at String 组织单元的创建时间。
  • 响应示例 状态码: 201 Successful { "organizational_unit" : { "id" : "ou-fi0rv9jbjgc6nifokh65jjo8c24fnujv", "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:ou:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/ou-fi0rv9jbjgc6nifokh65jjo8c24fnujv", "name" : "autoOU0923152728692gqQc", "created_at" : "2022-09-23T07:27:28Z" } }
  • 请求示例 创建组织单元 POST https://{hostname}/v1/organizations/organizational-units { "name" : "autoOU0923152728692gqQc", "parent_id" : "ou-kz0blhbszb6w9a2lzb", "tags" : [ { "key" : "keystring", "value" : "keystring" } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 organizational_unit OrganizationalUnitDto object 包含有关新创建的组织单元的详细信息的结构。 表5 OrganizationalUnitDto 参数 参数类型 描述 id String 与组织单元关联的唯一标识符(ID)。 最小长度:1 最大长度:35 urn String 组织单元的统一资源名称。 最小长度:1 最大长度:1500 name String 组织单元的名称。 最小长度:1 最大长度:64 created_at String 组织单元的创建时间。
  • 响应示例 状态码: 200 Successful { "organizational_unit" : { "id" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw", "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:ou:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/ou-fi0rv9jbjgc6nifokh65jjo8c24fnujv", "name" : "autoOU0923152729270Pkgk", "created_at" : "2022-09-23T07:27:28Z" } }
共100000条