华为云用户手册

  • URI GET /v1/organizations/policies 表1 Query参数 参数 是否必选 参数类型 描述 attached_entity_id 否 String 根、组织单元或账号的唯一标识符(ID)。 最大长度:100 limit 否 Integer 页面中最大结果数量。 最小值:1 最大值:2000 缺省值:200 marker 否 String 分页标记。 最小长度:4 最大长度:400
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 最小值:1 表3 请求Body参数 参数 是否必选 参数类型 描述 description 否 String 描述信息。如果为空字符串,则表示把描述信息设置为空。如果为NULL,则不做任何处理。 最小长度:0 最大长度:128
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 account AccountDto object 包含组织成员的账号的有关信息。 表5 AccountDto 参数 参数类型 描述 id String 账号的唯一标识符(ID)。 最大长度:64 urn String 账号的统一资源名称。 最小长度:1 最大长度:1500 join_method String 账号加入组织的方式。invited:邀请加入,created:创建加入。 最小长度:1 最大长度:64 status String 账号当前的状态。active:有效; suspended:已关闭; pending_closure:关闭中。 最小长度:1 最大长度:64 joined_at String 账号加入组织的日期。 name String 账号名称 最大长度:64 mobile_phone String 手机号码 最小长度:1 最大长度:32 intl_number_prefix String 手机号前缀。 最小长度:1 最大长度:10 email String 与此账号关联的电子邮件地址。 最大长度:64 description String 描述信息。 最小长度:1 最大长度:128
  • 响应示例 状态码: 200 Successful { "account" : { "id" : "05261f923e80d3890f33c0056e9b3f80", "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:account:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/05261f923e80d3890f33c0056e9b3f80", "join_method" : "invited", "status" : "active", "joined_at" : "2022-08-24T06:41:15Z", "name" : "paas_iam_573331", "description" : "string" } }
  • URI POST /v1/organizations/{resource_type}/{resource_id}/tags/create 表1 路径参数 参数 是否必选 参数类型 描述 resource_type 是 String 资源类型。枚举值:organizations:policies(服务策略)、organizations:ous(组织OU)、organizations:accounts(账号信息) 、organizations:roots:(根)。 resource_id 是 String 根、组织单元、账号或策略的唯一标识符(ID)。 最大长度:130
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 最小值:1 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 是 Array of TagDto objects 要添加到指定资源的标签列表。 数组长度:1 - 20 表4 TagDto 参数 是否必选 参数类型 描述 key 是 String 标签键的密钥标识符或名称。 最小长度:1 最大长度:128 value 是 String 与标签键关联的字符串值。您可以将标签的值设置为空字符串,但不能将标签的值设置为NULL。 最小长度:0 最大长度:255
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 organizational_units Array of OrganizationalUnitDto objects 组织单元列表。 page_info PageInfoDto object 分页信息 表4 OrganizationalUnitDto 参数 参数类型 描述 id String 与组织单元关联的唯一标识符(ID)。 最小长度:1 最大长度:35 urn String 组织单元的统一资源名称。 最小长度:1 最大长度:1500 name String 组织单元的名称。 最小长度:1 最大长度:64 created_at String 组织单元的创建时间。 表5 PageInfoDto 参数 参数类型 描述 next_marker String 如果存在,则表示可用的输出比当前响应中包含的输出多。在对操作的后续调用中,在标签请求参数中使用此值,以获取输出的下一部分。您应该重复此操作,直到next_marker响应元素返回为null。 current_count Integer 本页返回条目数量 最小值:1 最大值:2000
  • 响应示例 状态码: 200 Successful { "organizational_units" : [ { "id" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw", "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:ou:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw", "name" : "autoOU0923152729270Pkgk", "created_at" : "2022-09-23T07:27:28Z" } ], "page_info" : { "next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw", "current_count" : 100 } }
  • URI GET /v1/organizations/organizational-units 表1 Query参数 参数 是否必选 参数类型 描述 parent_id 否 String 父节点(根或组织单元)的唯一标识符(ID)。 最大长度:100 limit 否 Integer 页面中最大结果数量。 最小值:1 最大值:2000 缺省值:200 marker 否 String 分页标记。 最小长度:4 最大长度:400
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 services Array of TagPolicyServiceDto objects 被添加到标签策略强制执行的资源类型。 表3 TagPolicyServiceDto 参数 参数类型 描述 service_name String 服务名称。 最小长度:1 最大长度:64 resource_types Array of strings 资源类型。 support_all Boolean resource_type是否支持全量选择,即*
  • 响应示例 状态码: 200 Successful. { "handshake" : { "id" : "h-awjp43m7bz3b8jgy5v61jrfwakt3og8w", "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:handshake:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/h-awjp43m7bz3b8jgy5v61jrfwakt3og8w", "updated_at" : "2022-08-25T08:11:53Z", "created_at" : "2022-08-25T08:11:20Z", "expired_at" : "2022-09-08T08:11:20Z", "management_account_id" : "0a6d25d23900d45c0faac010e0fb4de0", "management_account_name" : "paas_iam_573331", "organization_id" : "o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv", "notes" : "test-notes", "target" : { "type" : "account", "entity" : "05c734152f00d4200f2bc0179ac6c5e0" }, "status" : "declined" } }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 handshake HandshakeDto object 两个账号(发起者和接收者)之间为了能安全地建立关系,所需要交换的信息。例如,当管理账号(发起者)邀请另一个账号(接收者)加入其组织时,两个账号一系列邀请(握手)请求和响应交换信息。 表4 HandshakeDto 参数 参数类型 描述 id String 邀请(握手)的唯一标识符(ID)。源账号在发起邀请(握手)时创建ID。 最大长度:34 urn String 邀请(握手)的统一资源名称。 最小长度:1 最大长度:1500 updated_at String 邀请(握手)请求被接受、取消、拒绝或到期的日期和时间。 created_at String 提出邀请(握手)请求的日期和时间。 expired_at String 邀请(握手)过期的日期和时间。 management_account_id String 组织管理账号的唯一标识符(ID)。 最大长度:64 management_account_name String 组织管理账号的名称。 最大长度:64 organization_id String 组织的唯一标识符(ID)。 最大长度:34 notes String 给收件账号所有者的邮件中的附加信息。 最大长度:1024 target TargetDto object 要邀请加入组织的账号的标识符(ID)。 status String 邀请(握手)的当前状态, pending:邀请中;accepted:接受邀请;cancelled:取消邀请;declined:拒绝邀请;expired:邀请过期。 最小长度:1 最大长度:64 表5 TargetDto 参数 参数类型 描述 type String 目标类型,account:账户id,name:账户名称。 最小长度:1 最大长度:64 entity String 如果指定 'type:account',则必须提供账号ID作为实体。如果指定 'type:name',则必须指定账号名称作为实体。 最小长度:1 最大长度:100
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 最小值:1 表3 请求Body参数 参数 是否必选 参数类型 描述 source_parent_id 是 String 要移出账号的根或组织单元的唯一标识符(ID)。 最大长度:100 destination_parent_id 是 String 要移入账号的根或组织单元的唯一标识符(ID)。 最大长度:100
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 handshake HandshakeDto object 两个账号(发起者和接收者)之间为了能安全地建立关系,所需要交换的信息。例如,当管理账号(发起者)邀请另一个账号(接收者)加入其组织时,两个账号一系列邀请(握手)请求和响应交换信息。 表4 HandshakeDto 参数 参数类型 描述 id String 邀请(握手)的唯一标识符(ID)。源账号在发起邀请(握手)时创建ID。 最大长度:34 urn String 邀请(握手)的统一资源名称。 最小长度:1 最大长度:1500 updated_at String 邀请(握手)请求被接受、取消、拒绝或到期的日期和时间。 created_at String 提出邀请(握手)请求的日期和时间。 expired_at String 邀请(握手)过期的日期和时间。 management_account_id String 组织管理账号的唯一标识符(ID)。 最大长度:64 management_account_name String 组织管理账号的名称。 最大长度:64 organization_id String 组织的唯一标识符(ID)。 最大长度:34 notes String 给收件账号所有者的邮件中的附加信息。 最大长度:1024 target TargetDto object 要邀请加入组织的账号的标识符(ID)。 status String 邀请(握手)的当前状态, pending:邀请中;accepted:接受邀请;cancelled:取消邀请;declined:拒绝邀请;expired:邀请过期。 最小长度:1 最大长度:64 表5 TargetDto 参数 参数类型 描述 type String 目标类型,account:账户id,name:账户名称。 最小长度:1 最大长度:64 entity String 如果指定 'type:account',则必须提供账号ID作为实体。如果指定 'type:name',则必须指定账号名称作为实体。 最小长度:1 最大长度:100
  • 响应示例 状态码: 200 Successful. { "handshake" : { "id" : "h-awjp43m7bz3b8jgy5v61jrfwakt3og8w", "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:handshake:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/h-awjp43m7bz3b8jgy5v61jrfwakt3og8w", "updated_at" : "2022-08-25T08:11:53Z", "created_at" : "2022-08-25T08:11:20Z", "expired_at" : "2022-09-08T08:11:20Z", "management_account_id" : "0a6d25d23900d45c0faac010e0fb4de0", "management_account_name" : "paas_iam_573331", "organization_id" : "o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv", "notes" : "test-notes", "target" : { "type" : "account", "entity" : "05c734152f00d4200f2bc0179ac6c5e0" }, "status" : "accepted" } }
  • 响应示例 状态码: 200 Successful. { "trusted_services" : [ { "service_principal" : "autoservice0922102321263V58H", "enabled_at" : "2022-09-22T02:23:21Z" } ], "page_info" : { "next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw", "current_count" : 100 } }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 trusted_services Array of TrustedServiceDto objects 启用与组织集成的服务主体列表。 page_info PageInfoDto object 分页信息 表4 TrustedServiceDto 参数 参数类型 描述 service_principal String 可信服务的名称。 最小长度:1 最大长度:100 enabled_at String 可信服务与组织集成的日期。 表5 PageInfoDto 参数 参数类型 描述 next_marker String 如果存在,则表示可用的输出比当前响应中包含的输出多。在对操作的后续调用中,在标签请求参数中使用此值,以获取输出的下一部分。您应该重复此操作,直到next_marker响应元素返回为null。 current_count Integer 本页返回条目数量 最小值:1 最大值:2000
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 最小值:1 表2 请求Body参数 参数 是否必选 参数类型 描述 service_principal 是 String 服务主体名称。 最小长度:1 最大长度:100 account_id 是 String 账号的唯一标识符(ID)。 最大长度:64
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 organization OrganizationDto object 包含有关组织的详细信息。组织是账号集合,由组织单元构成的层次结构,并通过策略控制。 表3 OrganizationDto 参数 参数类型 描述 id String 组织的唯一标识符(ID)。 最大长度:34 urn String 组织的统一资源名称。 最小长度:1 最大长度:1500 management_account_id String 组织管理账号的唯一标识符(ID)。 最大长度:64 management_account_name String 组织的管理账号的名称。 最大长度:64 created_at String 组织的创建时间。
  • 响应示例 状态码: 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" } }
  • 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 } }
  • 响应参数 状态码: 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
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 最小值:1 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 是 Array of TagDto objects 要添加到指定资源的标签列表。 数组长度:1 - 20 表4 TagDto 参数 是否必选 参数类型 描述 key 是 String 标签键的密钥标识符或名称。 最小长度:1 最大长度:128 value 是 String 与标签键关联的字符串值。您可以将标签的值设置为空字符串,但不能将标签的值设置为NULL。 最小长度:0 最大长度:255
  • 响应示例 状态码: 200 Successful { "close_account_statuses" : [ { "account_id" : "0a6d25d23900d45c0faac010e0fb4de0", "updated_at" : "2022-08-24T06:41:15Z", "created_at" : "2022-08-24T06:41:15Z", "organization_id" : "o-awjp43m7bz3b8jgy5v61jrfwakt3og8w", "state" : "pending_closure", "failure_reason" : "string" } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 close_account_statuses Array of CloseAccountStatusDto objects 包含有关请求的详细信息的对象列表。 表4 CloseAccountStatusDto 参数 参数类型 描述 account_id String 账号的唯一标识符(ID)。 最大长度:64 created_at String 请求关闭账号的日期和时间。 updated_at String 请求关闭账号状态更新的日期和时间。 organization_id String 组织的唯一标识符(ID)。 最大长度:34 state String 关闭账号的状态,pending_closure:关闭中,suspended:已关闭 最小长度:1 最大长度:64 failure_reason String 如果请求失败,则说明失败原因。
  • 响应示例 状态码: 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
  • URI GET /v1/organizations/accounts/{account_id}/delegated-services 表1 路径参数 参数 是否必选 参数类型 描述 account_id 是 String 账号的唯一标识符(ID)。 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 页面中最大结果数量。 最小值:1 最大值:2000 缺省值:200 marker 否 String 分页标记。 最小长度:4 最大长度:400
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 最小值:1 表2 请求Body参数 参数 是否必选 参数类型 描述 policy_type 是 String 策略类型的名称,service_control_policy服务控制策略;tag_policy:标签策略。 root_id 是 String 根的唯一标识符(ID)。 最大长度:34
共100000条