华为云用户手册

  • 其他 权限 对应API接口 授权项(Action) IAM 项目(Project) 企业项目(Enterprise Project) 查询有效的策略 GET /v1/organizations/entities/effective-policies organizations:effectivePolicies:get × × 列出组织中的根、组织单元和账号 GET /v1/organizations/entities organizations:entities:list × × 列出所有可以与组织服务集成的云服务 GET /v1/organizations/services organizations:services:list × × 列出被添加到标签策略强制执行的资源类型 GET /v1/organizations/tag-policy-services organizations:tagPolicyServices:list × × 列出租户的组织配额 GET /v1/organizations/quotas organizations:quotas:list × ×
  • 标签管理 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 列出绑定到指定资源的标签 GET /v1/organizations/resources/{resource_id}/tags organizations:tags:list × × 为指定的资源添加标签 POST /v1/organizations/resources/{resource_id}/tag organizations:resources:tag × × 从指定资源中删除指定主键标签 POST /v1/organizations/resources/{resource_id}/untag organizations:resources:untag × × 列出绑定到指定资源的标签 GET /v1/organizations/{resource_type}/{resource_id}/tags organizations:tags:list × × 为指定资源添加标签 POST /v1/organizations/{resource_type}/{resource_id}/tags/create organizations:resources:tag × × 从指定资源中删除指定主键标签 POST /v1/organizations/{resource_type}/{resource_id}/tags/delete organizations:resources:untag × × 根据资源类型及标签信息查询实例列表 POST /v1/organizations/{resource_type}/resource-instances/filter organizations:resources:listByTag × × 根据资源类型及标签信息查询实例数量 POST /v1/organizations/{resource_type}/resource-instances/count organizations:resources:countByTag × × 查询资源标签 GET /v1/organizations/{resource_type}/tags organizations:resources:list × ×
  • 组织单元管理 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 创建组织单元 POST /v1/organizations/organizational-units organizations:ous:create organizations:resources:tag(如果请求带标签) × × 列出组织单元 GET /v1/organizations/organizational-units organizations:ous:list × × 查询有关组织单元的信息 GET /v1/organizations/organizational-units/{organizational_unit_id} organizations:ous:get × × 更改组织单元名称 PATCH /v1/organizations/organizational-units/{organizational_unit_id} organizations:ous:update × × 删除组织单元 DELETE /v1/organizations/organizational-units/{organizational_unit_id} organizations:ous:delete × ×
  • 可信服务管理 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 启用可信服务 POST /v1/organizations/enable-trusted-service organizations:trustedServices:enable × × 禁用受信任服务 POST /v1/organizations/disable-trusted-service organizations:trustedServices:disable × × 列出组织的可信服务列表 GET /v1/organizations/trusted-services organizations:trustedServices:list × ×
  • 账号管理 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 创建账号 POST /v1/organizations/accounts organizations:accounts:create organizations:resources:tag(如果请求带标签) × × 列出组织中的账号 GET /v1/organizations/accounts organizations:accounts:list × × 查询账号信息 GET /v1/organizations/accounts/{account_id} organizations:accounts:get × × 移除指定的账号 POST /v1/organizations/accounts/{account_id}/remove organizations:accounts:remove × × 移动账号 POST /v1/organizations/accounts/{account_id}/move organizations:accounts:move × × 邀请账号加入组织 POST /v1/organizations/invite-account organizations:accounts:invite organizations:resources:tag(如果请求带标签) × × 列出创建账号的状态 GET /v1/organizations/create-account-statuses organizations:createAccountStatuses:list × × 查询有关创建账号状态的信息 GET /v1/organizations/create-account-statuses/{create_account_status_id} organizations:createAccountStatuses:get × ×
  • 邀请管理 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 查询邀请相关信息 GET /v1/organizations/handshakes/{handshake_id} organizations:handshakes:get × × 接受邀请 POST/v1/received-handshakes/{handshake_id}/accept organizations:handshakes:accept iam:agencies:createServiceLinkedAgency × × 拒绝邀请 POST /v1/received-handshakes/{handshake_id}/decline organizations:handshakes:decline × × 取消邀请 POST /v1/organizations/handshakes/{handshake_id}/cancel organizations:handshakes:cancel × × 列出收到的邀请 GET /v1/received-handshakes organizations:receivedHandshakes:list × × 列出发送的邀请 GET /v1/organizations/handshakes organizations:handshakes:list × ×
  • 委托管理员管理 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 注册作为服务委托管理员 POST /v1/organizations/delegated-administrators/register organizations:delegatedAdministrators:register × × 注销服务的委托管理员 POST /v1/organizations/delegated-administrators/deregister organizations:delegatedAdministrators:deregister × × 列出指定账号是其委托管理员的服务 GET /v1/organizations/accounts/{account_id}/delegated-services organizations:delegatedServices:list × × 列出此组织中指定为委托管理员的账号 GET /v1/organizations/delegated-administrators organizations:delegatedAdministrators:list × ×
  • 组织管理 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 创建组织 POST /v1/organizations organizations:organizations:create iam:agencies:createServiceLinkedAgency × × 查询所属组织信息 GET /v1/organizations organizations:organizations:get × × 删除组织 DELETE /v1/organizations organizations:organizations:delete × × 离开当前组织 POST /v1/organizations/leave organizations:organizations:leave × × 列出组织的根 GET /v1/organizations/roots organizations:roots:list × ×
  • 响应示例 状态码: 200 Successful. { "trusted_services" : [ { "service_principal" : "autoservice0922102321263V58H", "enabled_at" : "2022-09-22T02:23:21Z" } ], "page_info" : { "next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw", "current_count" : 100 }}
  • 获取账号、IAM用户、项目的名称和ID 从控制台获取账号名、账号ID、用户名、用户ID、项目名称、项目ID 在华为云首页右上角,单击“控制台”。 在右上角的用户名中选择“我的凭证”。 图1 进入我的凭证 在“我的凭证”界面,API凭证页签中,查看账号名、账号ID、用户名、用户ID、项目名称、项目ID。 每个区域的项目ID有所不同,需要根据业务所在的区域获取对应的项目ID。 图2 查看账号名、账号ID、用户名、用户ID、项目名称、项目ID 调用API获取用户ID、项目ID 获取用户ID请参考:管理员查询IAM用户列表。 获取项目ID请参考:查询指定条件下的项目列表。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 trusted_services Array of TrustedServiceDto objects 启用与组织集成的服务主体列表。 page_info PageInfoDto object 分页信息 表4 TrustedServiceDto 参数 参数类型 描述 service_principal String 可信服务的名称。 enabled_at String 可信服务与组织集成的日期。 表5 PageInfoDto 参数 参数类型 描述 next_marker String 如果存在,则表示可用的输出比当前响应中包含的输出多。在对操作的后续调用中,在标签请求参数中使用此值,以获取输出的下一部分。您应该重复此操作,直到next_marker响应元素返回为null。 current_count Integer 本页返回条目数量
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 roots Array of RootDto objects 在组织中定义的根列表。 page_info PageInfoDto object 分页信息 表4 RootDto 参数 参数类型 描述 id String 根的唯一标识符(ID)。 urn String 根的统一资源名称。 name String 根的名称。 policy_types Array of PolicyTypeSummaryDto objects 策略类型在当前根已启用,则该类型策略可以绑定到根或其组织单元或账号。 created_at String 根的创建时间。 表5 PolicyTypeSummaryDto 参数 参数类型 描述 status String 与根关联的策略类型状态。要将指定类型的策略绑定到根或该根中的组织单元或账号,该策略必须在组织中可用,并在该根已启用。enabled:启用;pending_enable:启用中;disabled:禁用;pending_disable:禁用中。 type String 策略类型的名称,service_control_policy:服务控制策略;tag_policy:标签策略。 表6 PageInfoDto 参数 参数类型 描述 next_marker String 如果存在,则表示可用的输出比当前响应中包含的输出多。在对操作的后续调用中,在标签请求参数中使用此值,以获取输出的下一部分。您应该重复此操作,直到next_marker响应元素返回为null。 current_count Integer 本页返回条目数量
  • 响应示例 状态码: 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 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 表4 响应Body参数 参数 参数类型 描述 organizational_unit OrganizationalUnitDto object 包含有关新创建的组织单元的详细信息的结构。 表5 OrganizationalUnitDto 参数 参数类型 描述 id String 与组织单元关联的唯一标识符(ID)。 urn String 组织单元的统一资源名称。 name String 组织单元的名称。 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" }}
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 organization OrganizationDto object 包含有关组织的详细信息。组织是账号集合,由组织单元构成的层次结构,并通过策略控制。 表3 OrganizationDto 参数 参数类型 描述 id String 组织的唯一标识符(ID)。 urn String 组织的统一资源名称。 management_account_id String 组织管理账号的唯一标识符(ID)。 management_account_name String 组织的管理账号的名称。 created_at String 组织的创建时间。
  • 标签管理 表8 接口说明 接口 说明 列出绑定到指定资源的标签 列出绑定到指定资源的标签。您可以将标签附加到组织中的账号、组织单元、根和策略。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。 为指定的资源添加标签 向指定的资源添加一个或多个标签。目前,您可以将标签附加到组织中的账号、组织单元、根和策略。此操作只能由组织的管理账号调用。 从指定资源中删除指定主键标签 从指定资源中删除具有指定主键的任何标签。您可以将标签绑定到组织中的账号、组织单元、根和策略。此操作只能由组织的管理账号调用。 列出绑定到指定资源的标签 列出绑定到指定资源的标签。您可以将标签附加到组织中的账号、组织单元、根和策略。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。 为指定资源添加标签 向指定的资源添加一个或多个标签。目前,您可以将标签附加到组织中的账号、组织单元、根和策略。此操作只能由组织的管理账号调用。 从指定资源中删除指定主键标签 从指定资源中删除具有指定主键的任何标签。您可以将标签绑定到组织中的账号、组织单元、根和策略。此操作只能由组织的管理账号调用。 根据资源类型及标签信息查询实例列表 根据资源类型及标签信息查询实例列表。 根据资源类型及标签信息查询实例数量 根据资源类型及标签信息查询实例数量。 查询资源标签 查询指定资源类型的标签。
  • 其他 表9 接口说明 接口 说明 查询有效的策略 查询指定策略类型和账号的有效策略信息。当前此接口不支持查询服务控制策略(service_control_policy)。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。 列出组织中的根、组织单元和账号 列出组织中包含的所有根、组织单元和账号。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。您可以通过指定父ID和子ID参数来过滤实体。 列出所有可以与组织服务集成的云服务 列出所有可以与组织服务集成的云服务。集成后云服务将成为组织的可信服务。 列出被添加到标签策略强制执行的资源类型 列出被添加到标签策略强制执行的资源类型。 列出租户的组织配额 列出租户的组织配额。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。
  • 组织单元管理 表2 接口说明 接口 说明 创建组织单元 在根或父组织单元中创建组织单元。组织单元是账号的容器,使您能够对账号进行分组管理,并根据业务要求应用策略。此操作只能由组织的管理账号调用。 列出组织单元 列出组织中的所有组织单元。如果指定父级组织单元,则将获得父级直系子级的组织单元列表。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。 查询有关组织单元的信息 查询有关组织单元的信息。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。 更改组织单元名称 重命名指定的组织单元。重命名后组织单元ID不变,下属子组织单元和下属账号不变,组织单元绑定的策略不变。此操作只能由组织的管理账号调用。 删除组织单元 从根或其他组织单元中删除组织单元。前提是您必须先移除该组织单元中的所有成员账号或将成员账号移动至其他组织单元,必须删除该组织单元中的所有子组织单元。此操作只能由组织的管理账号调用。
  • 委托管理员管理 表6 接口说明 接口 说明 注册作为服务委托管理员 指定成员账号能够管理指定服务的组织功能。此接口授予委托管理员对组织服务数据的只读访问权限。委托管理员账号中的IAM用户仍需要IAM权限才能访问和管理服务。此操作只能由组织的管理账号调用。 注销服务的委托管理员 删除指定成员账号作为指定服务的委托管理员。此操作只能由组织的管理账号调用。 列出指定账号是其委托管理员的服务 列出指定账号是其委托管理员的服务。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。 列出此组织中指定为委托管理员的账号 列出在此组织中指定为委派管理员的账号。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。
  • 组织管理 表1 接口说明 接口 说明 创建组织 创建组织。调用此接口的账号将自动成为新组织的管理账号,调用此接口的账号凭证必须是新组织管理账号的账号凭证。 查询所属组织信息 查询账号所属组织的信息。此操作可以由组织中的任何账号调用。 删除组织 删除组织。您必须使用管理账号才能删除组织,并且先移除组织中的所有账号、组织单元和策略。 离开当前组织 此操作只能由组织的成员账号调用。只有当组织账号配置了作为独立账号运行所需的信息时,您才能作为成员账号离开组织。要离开的账号不能是组织启用的任何服务的委托管理员账号。 列出组织的根 列出当前组织的根。此接口只能由组织的管理账号或作为服务委托管理员的成员账号调用。
  • 邀请管理 表4 接口说明 接口 说明 查询邀请相关信息 查询组织中已有账号邀请的相关信息。此接口可以由组织中的任何账号调用。 接受邀请 向邀请的发起方发送应答,接受加入组织邀请。在您接受邀请后,此邀请信息将继续保留并出现在相关API的返回结果中,保留期限为30天。 拒绝邀请 拒绝邀请请求。受邀账号拒绝邀请,此时当前邀请状态将设置为拒绝,邀请停止。此接口只能由受邀账号调用。邀请发起者无法再次激活被拒绝的邀请,但可以重新发送新的邀请。 取消邀请 取消邀请,此时邀请状态将设置为已取消。此接口只能由发起邀请的账号调用。取消邀请后,此邀请信息将继续保留并出现在相关API的返回结果中,保留期限为30天。 列出收到的邀请 列出账号收到的所有邀请。此操作可以由任何账号调用。 列出发送的邀请 列出所属组织发送的邀请。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。
  • 策略管理 表7 接口说明 接口 说明 创建策略 创建指定类型的策略。此操作只能由组织的管理账号调用。 列出策略 列出组织中的所有策略。如果指定了资源ID,例如组织单元ID或账号ID,则将获得该资源已绑定的策略列表。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。 查询策略相关信息 检索策略的相关信息。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。 更新策略 更新策略,可以更新策略的名称、描述或内容。如果不提供任何参数,则策略将保持不变。您不能更改策略的类型。此操作只能由组织的管理账号调用。 删除策略 从组织中删除指定的策略。在执行此操作之前,必须首先将策略跟所有组织单元、根和账号解绑。此操作只能由组织的管理账号调用。 在根中启用策略类型 在根中启用策略类型。在根中启用策略类型后,您可以将该类型的策略绑定到根、或该根中的任何组织单元和账号。这是在后台执行的异步请求。您可以使用ListRoots查看指定根的策略类型的状态。此操作只能由组织的管理账号调用。 禁用根中的策略类型 禁用根中的策略类型。只有在根中启用了特定类型的策略,才能将该类型的策略绑定到根中的实体。执行此操作后,您不能再将指定类型的策略绑定到该根或该根中的任何组织单元或账号。这是在后台执行的异步请求。您可以使用ListRoots查看指定根的策略类型的状态。此操作只能由组织的管理账号调用。 将策略跟实体绑定 绑定策略到根、组织单元或个人账号。此操作只能由组织的管理账号调用。 将策略跟实体解绑 从根、组织单元或账号解绑策略。此操作只能由组织的管理账号调用。 列出跟指定策略绑定的所有实体 列出跟指定策略绑定的所有根、组织单元和账号。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。
  • 可信服务管理 表5 接口说明 接口 说明 启用可信服务 启用服务(由service_principal指定的服务)与组织的集成。启用可信服务后,允许指定的可信服务对组织中的所有账号创建服务关联委托。这允许可信服务代表您在组织及其账号中执行操作。此接口只能由组织的管理账号调用。 禁用受信任服务 禁用服务(由service_principal指定的服务)与组织的集成。禁用可信服务后,指定服务将不可以在组织中的新账号中创建服务关联委托。这意味着该服务无法代表您对组织中的任何新账号执行操作。在服务完成从组织中的清理之前,服务仍可以在旧账号中执行操作。此接口只能由组织的管理账号调用。 列出组织的可信服务列表 返回启用与组织集成的可信服务列表。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。
  • 账号管理 表3 接口说明 接口 说明 创建账号 创建一个账号,生成的账号将自动成为调用此接口的账号所属组织的成员。此操作只能由组织的管理账号调用。组织云服务将在新账号中创建所需的服务关联委托和账号访问委托。 列出组织中的账号 列出组织中的账号。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。如果指定父级组织单元,则将获得作为父级直系子级的所有账号的列表。 关闭账号 关闭在组织中直接创建的账号。 查询账号信息 查询有关指定账号的信息。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。 移除指定的账号 从组织中移除指定的账号。移除的账号将成为一个独立账号,该账号不是任何组织的成员。此操作只能由组织的管理账号调用。只有当账号配置了作为独立账号运行所需的信息时,您才能从组织中移除账号。注意,要移除的账号不能是组织启用的任何服务的委托管理员账号。 移动账号 将账号从其当前源位置(根或组织单元)移动到指定的目标位置(根或组织单元)。 邀请账号加入组织 向另一个账号发送邀请,受邀账号将以成员账号加入您的组织。此操作只能由组织的管理账号调用。 列出创建账号的状态 列出组织中指定状态的账号创建请求。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。 查询有关创建账号状态的信息 检索创建账号的异步请求的当前状态。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 organizational_unit OrganizationalUnitDto object 包含有关新创建的组织单元的详细信息的结构。 表4 OrganizationalUnitDto 参数 参数类型 描述 id String 与组织单元关联的唯一标识符(ID)。 urn String 组织单元的统一资源名称。 name String 组织单元的名称。 created_at String 组织单元的创建时间。
  • 支持的授权项 策略包含系统策略和自定义策略,如果系统策略不满足授权要求,管理员可以创建自定义策略,并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应,授权项列表说明如下: 权限:允许或拒绝对指定资源在特定条件下进行某项操作。 对应API接口:自定义策略实际调用的API接口。 授权项:自定义策略中支持的Action,在自定义策略中的Action中写入授权项,可以实现授权项对应的权限功能。 依赖的授权项:部分Action存在对其他Action的依赖,需要将依赖的Action同时写入授权项,才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project):自定义策略的授权范围,包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目,表示此授权项对应的自定义策略,可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目,不支持企业项目,表示仅能在IAM中给用户组授权并生效,如果在企业管理中授权,则该自定义策略不生效。管理员可以在授权项列表中查看授权项是否支持IAM项目或企业项目,“√”表示支持,“×”表示暂不支持。关于IAM项目与企业项目的区别,详情请参见:IAM与企业管理的区别。
  • 响应示例 状态码: 200 Successful { "organizational_unit" : { "id" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw", "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:ou:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw", "name" : "autoOU0923152729270Pkgk", "created_at" : "2022-09-23T07:27:28Z" }}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 account AccountDto object 包含组织成员的账号的有关信息。 表5 AccountDto 参数 参数类型 描述 id String 账号的唯一标识符(ID)。 urn String 账号的统一资源名称。 join_method String 账号加入组织的方式。invited:邀请加入,created:创建加入。 status String 账号当前的状态。active:有效; suspended:已关闭; pending_closure:关闭中。 joined_at String 账号加入组织的日期。 name String 账号名称 mobile_phone String 手机号码 intl_number_prefix String 手机号前缀。 email String 与此账号关联的电子邮件地址。 description String 描述信息。
共100000条