华为云用户手册

  • 响应示例 状态码为 200 时: 请求成功。 { "api_acl_policy" : { "allow_ip_ranges" : [ { "ip_range" : "0.0.0.0-255.255.255.255", "description" : "" }, { "ip_range" : "0.0.0.0-255.255.255.255", "description" : "" } ], "allow_address_netmasks" : [ { "address_netmask" : "192.168.0.1/24", "description" : "" }, { "address_netmask" : "192.168.0.1/24", "description" : "" } ] } }
  • URI DELETE /v3.0/OS-INHERIT/domains/{domain_id}/agencies/{agency_id}/roles/{role_id}/inherited_to_projects 表1 路径参数 参数 是否必选 参数类型 描述 agency_id 是 String 委托ID,获取方式请参见:获取账号、 IAM 用户、项目、用户组、区域、委托的名称和ID。 domain_id 是 String 委托方的账号ID,获取方式请参见:获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 role_id 是 String 权限ID,获取方式请参见:获取权限ID。
  • 响应示例 状态码: 400 请求参数出错。 { "error" : { "message" : "Illegal request", "code" : 400, "title" : "Bad Request" } } 状态码: 401 认证失败。 { "error" : { "message" : "Authentication failed", "code" : 401, "title" : "Unauthorized" } } 状态码: 403 没有操作权限。 { "error" : { "message" : "Forbidden operation", "code" : 403, "title" : "Forbidden" } }
  • URI PUT /v3.0/OS-PERMISSION/enterprise-projects/{enterprise_project_id}/users/{user_id}/roles/{role_id} 表1 路径参数 参数 是否必选 参数类型 描述 enterprise_project_id 是 String 企业项目ID。 user_id 是 String 用户ID。 role_id 是 String 权限ID。
  • 响应参数 表3 响应Body参数 参数 参数类型 描述 project Object 项目信息。 表4 project 参数 参数类型 描述 domain_id String 项目所属账号ID。 is_domain Boolean false. parent_id String 如果查询自己创建的项目,则此处返回所属区域的项目ID。 如果查询的是系统内置项目,如cn-north-1,则此处返回账号ID。 name String 项目名称。 description String 项目描述信息。 id String 项目ID。 enabled Boolean 项目是否可用。 status String 项目状态。
  • 响应示例 状态码为 200 时: 请求成功。 { "project": { "domain_id": "d78cbac186b744899480f25bd02...", "is_domain": false, "parent_id": "aa2d97d7e62c4b7da3ffdfc11551...", "name": "cn-north-1_IAMProject", "description": "IAMDescription", "id": "07707ab14980265e2f5fc003a02...", "enabled": true, "status": "normal" } }
  • 响应参数 表3 响应Body参数 参数 参数类型 描述 config Object 配置信息。 表4 config 参数 参数类型 描述 security_compliance Object 密码强度策略信息。 表5 config.security_compliance 参数 参数类型 描述 password_regex String 密码强度策略的正则表达式。 password_regex_description String 密码强度策略的描述。
  • 响应示例 状态码为 200 时: 请求成功。 { "config": { "security_compliance": { "password_regex": "^(?![A-Z]*$)(?![a-z]*$)(?![\\d]*$)(?![^\\W]*$)\\S{6,32}$", "password_regex_description": "The password must contain at least two of the following character types: uppercase letters, lowercase letters, digits, and special characters, and be a length between 6 and 32." } } }
  • URI DELETE /v3.0/OS-PERMISSION/enterprise-projects/{enterprise_project_id}/users/{user_id}/roles/{role_id} 表1 路径参数 参数 是否必选 参数类型 描述 enterprise_project_id 是 String 企业项目ID。 user_id 是 String 用户ID。 role_id 是 String 权限ID。
  • 请求示例 创建名为“IAMGroup”的用户组。 POST https://iam.myhuaweicloud.com/v3/groups { "group": { "description": "IAMDescription", "domain_id": "d78cbac186b744899480f25bd0...", "name": "IAMGroup" } }
  • 响应示例 状态码为 201 时: 创建成功。 { "group": { "description": "IAMDescription", "links": { "self": "https://iam.myhuaweicloud.com/v3/groups/077a4c7bcd8010d53fb7c003e9d966c2" }, "id": "077a4c7bcd8010d53fb7c003e9d966c2", "create_time": 1578969208707, "domain_id": "d78cbac186b744899480f25bd0...", "name": "IAMGroup" } }
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8” X-Auth-Token 是 String 访问令牌,承载用户的身份、权限等信息。 token所需权限请参见授权项。 表2 请求Body参数 参数 是否必选 参数类型 描述 group 是 Object 用户组信息。 表3 group 参数 是否必选 参数类型 描述 description 否 String 用户组描述信息,长度小于等于255字符。 domain_id 否 String 用户组所属账号ID,获取方式请参见:获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 name 是 String 用户组名,长度1~128字符之间。
  • 响应参数 表4 响应Body参数 参数 参数类型 描述 group Object 用户组信息。 表5 group 参数 参数类型 描述 description String 用户组描述信息。 id String 用户组ID。 domain_id String 用户组所属账号ID。 name String 用户组名。 links Object 用户组的资源链接信息。 create_time Long 用户组创建时间。 表6 group.links 参数 参数类型 描述 self String 资源链接地址。
  • 响应参数 表3 响应Body参数 参数 参数类型 描述 identity_provider Object 身份提供商信息。 表4 identity_provider 参数 参数类型 描述 sso_type String 身份提供商类型。当前支持如下两种: virtual_user_sso:联邦登录跳转后映射为虚拟用户。 iam_user_sso:联邦登录跳转后映射为实际存在的IAM用户。 默认配置为virtual_user_sso类型。 id String 身份提供商ID。 description String 身份提供商描述信息。 enabled Boolean 身份提供商是否启用,true为启用,false为停用,默认为false。 remote_ids Array of strings 身份提供商的联邦用户ID列表。 links Object 身份提供商的资源链接信息。 表5 identity_provider.links 参数 参数类型 描述 self String 身份提供商的资源链接地址。 protocols String 协议的资源链接地址。
  • 响应示例 状态码为 200 时: 请求成功。 { "identity_provider": { "remote_ids": [], "enabled": true, "id": "ACME", "sso_type": "iam_user_sso", "links": { "self": "https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers/ACME", "protocols": "https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers/ACME/protocols" }, "description": "Stores ACME identities." } }
  • URI HEAD /v3/OS-INHERIT/domains/{domain_id}/groups/{group_id}/roles/{role_id}/inherited_to_projects 表1 路径参数 参数 是否必选 参数类型 描述 domain_id 是 String 用户组所属账号ID,获取方式请参见:获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 group_id 是 String 用户组ID,获取方式请参见:获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 role_id 是 String 权限ID,获取方式请参见:获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。
  • URI PUT /v3.0/OS-AGENCY/domains/{domain_id}/agencies/{agency_id}/roles/{role_id} 表1 路径参数 参数 是否必选 参数类型 描述 agency_id 是 String 委托ID,获取方式请参见:获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 domain_id 是 String 委托方账号ID,获取方式请参见:获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 role_id 是 String 全局服务权限ID,获取方式请参见:获取权限ID。
  • 响应示例 状态码为 200 时: 请求成功。 { "projects": [ { "domain_id": "d78cbac186b744899480f25bd02...", "is_domain": false, "parent_id": "d78cbac186b744899480f25bd022...", "name": "af-south-1", "description": "", "links": { "self": "https://iam.myhuaweicloud.com/v3/projects/06f1cbbaf280106b2f14c00313a9d065" }, "id": "06f1cbbaf280106b2f14c00313a9...", "enabled": true }, { "domain_id": "d78cbac186b744899480f25bd02...", "is_domain": false, "parent_id": "d78cbac186b744899480f25bd022...", "name": "cn-north-1", "description": "", "links": { "self": "https://iam.myhuaweicloud.com/v3/projects/065a7c66da0010992ff7c0031e5a5e7d" }, "id": "065a7c66da0010992ff7c0031e5a5e7d", "enabled": true } ], "links": { "self": "https://iam.myhuaweicloud.com/v3/auth/projects" } }
  • 响应参数 表2 响应Body参数 参数 参数类型 描述 links Object 资源链接信息。 projects Array of objects 项目信息列表。 表3 links 参数 参数类型 描述 self String 资源链接地址。 表4 projects 参数 参数类型 描述 is_domain Boolean false. description String 项目描述信息。 links Object 项目的资源链接。 enabled Boolean 项目是否可用。 id String 项目ID。 parent_id String 如果查询自己创建的项目,则此处返回所属区域的项目ID。 如果查询的是系统内置项目,如cn-north-1,则此处返回账号ID。 domain_id String 项目所属账号ID。 name String 项目名称。 表5 projects.links 参数 参数类型 描述 self String 资源链接地址。
  • 响应示例 状态码为 200 时: 请求成功。 { "domains": [ { "description": "", "enabled": true, "id": "d78cbac186b744899480f25bd022f468", "links": { "self": "https://iam.myhuaweicloud.com/v3/domains/d78cbac186b744899480f25bd022f468" }, "name": "IAMDomain" } ], "links": { "self": "https://iam.myhuaweicloud.com/v3/auth/domains" } }
  • 响应参数 表2 响应Body参数 参数 参数类型 描述 domains Array of objects 账号信息列表。 links Object 资源链接信息。 表3 domains 参数 参数类型 描述 enabled Boolean 是否启用账号,true为启用,false为停用,默认为true。 id String 账号ID。 name String 账号名。 links Object 账号的资源链接信息。 description String 账号的描述信息。 表4 domains.links 参数 参数类型 描述 self String 资源链接地址。 表5 links 参数 参数类型 描述 self String 资源链接地址。
  • 响应参数 表3 响应Body参数 参数 参数类型 描述 protocol Object 协议信息。 表4 protocol 参数 参数类型 描述 id String 协议ID。 mapping_id String 映射ID。 links Object 协议的资源链接信息。 表5 protocol.links 参数 参数类型 描述 identity_provider String 身份提供商的资源链接地址。 self String 资源链接地址。
  • 响应示例 状态码为 200 时: 请求成功。 { "protocol": { "mapping_id": "ACME", "id": "saml", "links": { "self": "https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers/ACME/protocols/saml", "identity_provider": "https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers/ACME" } } }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 users Array of objects 用户信息。 表4 users 参数 参数类型 描述 domain_id String 授权用户所属账号ID。 id String 授权用户ID。 name String 授权用户名。 enabled Boolean 授权用户是否启用,true表示启用,false表示停用,默认为true。 description String 授权用户描述信息。 policy_num Integer 授权用户的策略数。 lastest_policy_time Long 用户最近与企业项目关联策略的时间(毫秒)。
  • 响应示例 状态码: 200 请求成功。 { "users" : [ { "domain_id" : "d78cbac186b744899480f25bd02...", "id" : "07667db96a00265f1fc0c003a...", "name" : "IAMUserA", "enabled" : true, "description" : "IAMDescriptionA", "policy_num" : 2, "lastest_policy_time" : 1589874427000 } ] }
  • URI DELETE /v3/domains/{domain_id}/groups/{group_id}/roles/{role_id} 表1 路径参数 参数 是否必选 参数类型 描述 domain_id 是 String 用户组所属账号ID,获取方式请参见:获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 group_id 是 String 用户组ID,获取方式请参见:获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 role_id 是 String 权限ID,获取方式请参见:获取权限ID。
  • URI HEAD /v3.0/OS-AGENCY/projects/{project_id}/agencies/{agency_id}/roles/{role_id} 表1 路径参数 参数 是否必选 参数类型 描述 agency_id 是 String 委托ID,获取方式请参见:获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 project_id 是 String 委托方的项目ID,获取方式请参见:获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 role_id 是 String 项目服务权限ID,获取方式请参见:获取权限ID。
  • 响应参数 表1 响应Body参数 参数 参数类型 描述 version Object Keystone API的3.0版本信息。 表2 version 参数 参数类型 描述 status String 版本状态。 updated String 最后更新时间。 links Array of objects 版本的资源链接信息。 id String 版本号,如v3.6。 media-types Array of objects 支持的消息格式。 表3 version.links 参数 参数类型 描述 rel String 链接类型。self:自助链接包含了版本链接的资源。bookmark:书签链接提供了一个永久资源的永久链接。alternate:备用链接包含了资源的替换表示形式。 href String 资源链接地址。 表4 version.media-types 参数 参数类型 描述 type String 媒体类型。 base String 基础类型。
  • 响应示例 状态码为 200 时: 请求成功。 { "version": { "media-types": [ { "type": "application/vnd.openstack.identity-v3+json", "base": "application/json" } ], "links": [ { "rel": "self", "href": "https://iam.myhuaweicloud.com/v3/" } ], "id": "v3.6", "updated": "2016-04-04T00:00:00Z", "status": "stable" } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。 X-Auth-Token 是 String 访问令牌,承载用户的身份、权限等信息。 token所需权限请参见授权项。 表3 请求Body参数 参数 是否必选 参数类型 描述 domain_id 是 String 用户所属账号ID。 xaccount_type 是 String 该字段为标识租户来源字段,默认为空。 metadata 是 String 该字段为用户IdP服务器的Metadata文件的内容。
共100000条