华为云用户手册

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 tags Array of TagsDTO objects 自定义标签键值对。 表4 TagsDTO 参数 参数类型 描述 key String 键。最大长度127个unicode字符。 key不能为空。 最小长度：1 最大长度：128 values Array of strings 值列表。每个值最大长度255个unicode字符。 最小长度：0 最大长度：255 数组长度：0 - 10

URI GET /v1/organizations/{resource_type}/tags 表1 路径参数 参数 是否必选 参数类型 描述 resource_type 是 String 资源类型。枚举值：organizations:policies（服务策略）、organizations:ous（组织OU）、organizations:accounts（账号信息） 、organizations:roots：（根）。

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

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。 最小值：1 表2 请求Body参数 参数 是否必选 参数类型 描述 policy_type 是 String 策略类型的名称，service_control_policy服务控制策略；tag_policy：标签策略。 root_id 是 String 根的唯一标识符（ID）。 最大长度：34

响应参数 状态码： 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

响应示例 状态码： 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", "mobile_phone" : "null,", "intl_number_prefix" : "null,", "email" : null } }

响应参数 状态码： 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

URI GET /v1/organizations/accounts/{account_id} 表1 路径参数 参数 是否必选 参数类型 描述 account_id 是 String 账号的唯一标识符（ID）。 最大长度：64 表2 Query参数 参数 是否必选 参数类型 描述 with_register_contact_info 否 Boolean 是否返回账号邮箱、手机号信息。缺省值为False，若此参数为True时，Limit最多200。

URI GET /v1/organizations/{resource_type}/{resource_id}/tags 表1 路径参数 参数 是否必选 参数类型 描述 resource_type 是 String 资源类型。枚举值：organizations:policies（服务策略）、organizations:ous（组织OU）、organizations:accounts（账号信息） 、organizations:roots：（根）。 resource_id 是 String 根、组织单元、账号或策略的唯一标识符（ID）。 最大长度：130 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 页面中最大结果数量。 最小值：1 最大值：2000 缺省值：200 marker 否 String 分页标记。 最小长度：4 最大长度：400

响应参数 状态码： 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

响应示例 状态码： 200 Successful. { "tags" : [ { "key" : "auto09230Uv5key", "value" : "auto0923XXFmvalue" } ], "page_info" : { "next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw", "current_count" : 100 } }

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

响应参数 状态码： 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" : "pending" } }

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

响应示例 状态码： 200 Successful. { "last_updated_at" : "2023-01-11T11:00:00Z", "policy_content" : "{\"tags\":{\"color\":{\"tag_value\":[],\"tag_key\":\"Color\",\"enforced_for\":[\"iam:policy\"]},\"key_string\":{\"tag_value\":[\"AA\",\"BB\",\"cc\"],\"tag_key\":\"key_String\",\"enforced_for\":[\"iam:policy\"]},\"project\":{\"tag_value\":[\"Maintenance\",\"Escalations\"],\"tag_key\":\"Project\"}}}", "policy_type" : "tag_policy", "entity_id" : "c2acfcdf5fc7461a88f20094963e56c8" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 last_updated_at String 有效策略最后更新时间。 policy_content String 有效策略文本内容。 最小长度：0 最大长度：20000 policy_type String 策略类型的名称。tag_policy标签策略。 entity_id String 根、组织单元或账号的唯一标识符（ID）。 最大长度：100

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。 最小值：1 X-Language 否 String 选择接口返回的信息的语言 表3 请求Body参数 参数 是否必选 参数类型 描述 content 否 String 要添加到新策略的策略文本内容。 最小长度：0 最大长度：20000 description 否 String 要分配给策略的可选说明。 最大长度：512 name 否 String 要分配给策略的名称。 最小长度：1 最大长度：64

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 policy PolicyDto object 包含有关策略的详细信息的结构。 表5 PolicyDto 参数 参数类型 描述 content String 策略的文本内容。 最小长度：0 最大长度：20000 policy_summary PolicySummaryDto object 包含有关策略的信息，但不包括内容。 表6 PolicySummaryDto 参数 参数类型 描述 is_builtin Boolean 一个布尔值，指示指定的策略是否为系统策略。如果为true，即为系统策略，则可以将策略附加到根、组织单元或账号，但不能编辑它。 description String 策略说明。 最大长度：512 id String 策略的唯一标识符（ID）。 最小长度：1 最大长度：130 urn String 策略的统一资源名称。 最小长度：1 最大长度：1500 name String 策略的名称。 最小长度：1 最大长度：64 type String 策略的类型,service_control_policy：服务控制策略；tag_policy：标签策略。 最小长度：1 最大长度：64

请求示例 更新策略 PATCH https://{hostname}/v1/organizations/policies/{policy_id} { "content" : "{\"Version\":\"5.0\",\"Statement\":[{\"Sid\":\"Statement1\",\"Effect\":\"Allow\",\"Action\":[\"*\"],\"Resource\":[\"*\"]}]}", "description" : "newdesc", "name" : "auto09231619598990t1HPolicyName" }

响应示例 状态码： 200 Successful. { "policy" : { "content" : "{\"Version\":\"5.0\",\"Statement\":[{\"Sid\":\"Statement1\",\"Effect\":\"Allow\",\"Action\":[\"*\"],\"Resource\":[\"*\"]}]}", "policy_summary" : { "is_builtin" : false, "description" : "newdesc", "id" : "p-xce633owqm0o1c929wno7l850z2rdr4m", "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:policy:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/service_control_policy/p-b4wpejd02o66g0pvfinvsatp4t9krfum", "name" : "auto09231619598990t1HPolicyName", "type" : "service_control_policy" } } }

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

响应参数 状态码： 201 表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. { "handshakes" : [ { "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" : "pending" } ], "page_info" : { "next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw", "current_count" : 100 } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 handshakes Array of HandshakeDto objects 邀请（握手）对象的列表，其中包含与指定账号关联的每个邀请（握手）的详细信息。 page_info PageInfoDto 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 表6 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

URI GET /v1/organizations/delegated-administrators 表1 Query参数 参数 是否必选 参数类型 描述 service_principal 否 String 服务主体的名称。 最小长度：1 最大长度：100 limit 否 Integer 页面中最大结果数量。 最小值：1 最大值：2000 缺省值：200 marker 否 String 分页标记。 最小长度：4 最大长度：400

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 delegated_administrators Array of DelegatedAdministratorDto objects 组织中委托管理员列表。 page_info PageInfoDto object 分页信息 表4 DelegatedAdministratorDto 参数 参数类型 描述 delegation_enabled_at String 将账号设置为委托管理员的日期。 account_id String 账号的唯一标识符（ID）。 最大长度：64 account_urn String 账号的统一资源名称。 最大长度：1500 join_method String 账号加入组织的方式,invited：邀请加入，created：创建加入。 最小长度：1 最大长度：64 joined_at String 账号成为组织一部分的日期。 account_name String 账号名称 最大长度：64 表5 PageInfoDto 参数 参数类型 描述 next_marker String 如果存在，则表示可用的输出比当前响应中包含的输出多。在对操作的后续调用中，在标签请求参数中使用此值，以获取输出的下一部分。您应该重复此操作，直到next_marker响应元素返回为null。 current_count Integer 本页返回条目数量 最小值：1 最大值：2000