华为云用户手册

  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。 X-Auth-Token 是 String 访问令牌,承载用户的身份、权限等信息。 token所需权限请参见授权项。 表3 请求Body参数 参数 是否必选 参数类型 描述 project 是 Object 需要修改的项目信息。 表4 project 参数 是否必选 参数类型 描述 name 否 String 项目名称,必须以存在的"区域ID_"开头,长度小于等于64。项目所属区域不能改变,即原项目名为“cn-north-1_IAMProject”时,新项目名只能以“cn-north-1_”开头。“name”与"description"至少填写一个。 description 否 String 项目描述,长度小于等于255字符。“name”与"description"至少填写一个。
  • 响应示例 状态码为 200 时: 请求成功。 { "project": { "is_domain": false, "description": "IAMDescription", "links": { "self": "https://iam.myhuaweicloud.com/v3/projects/07707ab14980265e2f5fc003a021bbc3" }, "extra": {}, "enabled": true, "id": "07707ab14980265e2f5fc003a021bbc3", "parent_id": "aa2d97d7e62c4b7da3ffdfc11551f878", "domain_id": "d78cbac186b744899480f25bd...", "name": "cn-north-1_IAMNewProject" }}
  • 响应参数 表5 响应Body参数 参数 参数类型 描述 project Object 项目信息。 表6 project 参数 参数类型 描述 is_domain Boolean false. description String 项目描述信息。 extra Object 项目的其他信息。 links Object 项目的资源链接。 enabled Boolean 项目是否可用。 id String 项目ID。 parent_id String 区域对应的项目ID,例如区域“华北-北京一”区域对应的项目ID为:04dd42abe48026ad2fa3c01ad7fa.....。 domain_id String 项目所属帐号ID。 name String 项目名称。 表7 project.links 参数 参数类型 描述 self String 资源链接地址。
  • 请求示例 修改项目的名称为“cn-north-1_IAMNewProject”,描述修改为“IAMDescription”。 PATCH https://iam.myhuaweicloud.com/v3/projects/{project_id} { "project": { "name": "cn-north-1_IAMNewProject", "description": "IAMDescription" }}
  • 响应参数 表3 响应Body参数 参数 参数类型 描述 project Object 项目信息。 表4 project 参数 参数类型 描述 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 project.links 参数 参数类型 描述 self String 资源链接地址。 previous String 前一邻接资源链接地址。 next String 后一邻接资源链接地址。
  • 响应示例 状态码为 200 时: 请求成功。 { "project": { "is_domain": false, "description": "", "links": { "self": "https://iam.myhuaweicloud.com/v3/projects/2e93d63d8d2249f5a4ac5e2c78586a6e" }, "enabled": true, "id": "2e93d63d8d2249f5a4ac5e2c78586a6e", "parent_id": "44c0781c83484eb9a4a5d4d233522cea", "domain_id": "44c0781c83484eb9a4a5d4d23...", "name": "MOS" }}
  • 响应示例 状态码为 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 资源链接地址。
  • URI GET /v3/users 表1 Query参数 参数 是否必选 参数类型 描述 domain_id 否 String IAM用户所属帐号ID,获取方式请参见:获取帐号、IAM用户、项目、用户组、区域、委托的名称和ID。 enabled 否 Boolean 是否启用IAM用户,true为启用,false为停用,默认为true。 name 否 String IAM用户名。 password_expires_at 否 String 密码过期时间。该值为null表示未设置密码过期时间。 格式为:password_expires_at={operator}:{timestamp}。 timestamp格式为:YYYY-MM-DDTHH:mm:ssZ。示例: password_expires_at=lt:2016-12-08T22:02:00Z 说明: operator取值范围:lt,lte,gt,gte,eq,neq。 lt:过期时间小于timestamp。 lte:过期时间小于等于timestamp。 gt:过期时间大于timestamp。 gte:过期时间大于等于timestamp。 eq:过期时间等于timestamp。 neq:过期时间不等于timestamp。
  • 响应参数 表3 响应Body参数 参数 参数类型 描述 links Object 资源链接信息。 users Array of objects IAM用户信息列表。 表4 links 参数 参数类型 描述 self String 资源链接地址。 previous String 前一邻接资源链接地址。 next String 后一邻接资源链接地址。 表5 users 参数 参数类型 描述 name String IAM用户名。 links Object IAM用户的资源链接信息。 domain_id String IAM用户所属帐号ID。 enabled Boolean IAM用户是否启用。true表示启用,false表示停用,默认为true。 id String IAM用户ID。 password_expires_at String IAM用户密码过期时间(UTC时间),“null”表示密码不过期。 description String IAM用户描述信息。 pwd_status Boolean IAM用户密码状态。true:需要修改密码,false:正常。 last_project_id String IAM用户退出系统前,在控制台最后访问的项目ID。 pwd_strength String IAM用户的密码强度。high:密码强度高;mid:密码强度中等;low:密码强度低。 表6 users.links 参数 参数类型 描述 self String 资源链接地址。 previous String 前一邻接资源链接地址。 next String 后一邻接资源链接地址。
  • 响应示例 状态码为 200 时: 请求成功。 { "links": { "next": null, "previous": null, "self": "https://iam.myhuaweicloud.com/v3/users" }, "users": [ { "domain_id": "d78cbac186b744899480f25bd02...", "name": "IAMUserA", "description": "IAMDescriptionA", "password_expires_at": null, "links": { "next": null, "previous": null, "self": "https://iam.myhuaweicloud.com/v3/users/07667db96a00265f1fc0c003a3..." }, "id": "07667db96a00265f1fc0c003a...", "enabled": true }, { "pwd_status": true, "domain_id": "d78cbac186b744899480f25bd02...", "last_project_id": "065a7c66da0010992ff7c0031e5a...", "name": "IAMUserB", "description": "IAMDescriptionB", "password_expires_at": null, "links": { "next": null, "previous": null, "self": "https://iam.myhuaweicloud.com/v3/users/07609fb9358010e21f7bc003751c7..." }, "id": "07609fb9358010e21f7bc003751c7...", "enabled": true } ]}
  • 响应示例 状态码为 200 时: 请求成功。 { "quotas" : { "resources" : [ { "max" : 50, "min" : 0, "quota" : 10, "type" : "project", "used" : 4 } ] } }
  • 响应参数 表3 响应Body参数 参数 参数类型 描述 quotas object 帐号配额信息。 表4 quotas 参数 参数类型 描述 resources Array of objects 资源信息 表5 resources 参数 参数类型 描述 max Integer 配额最大值。 min Integer 配额最小值。 quota Integer 当前配额。 type String 配额类型。 used Integer 已使用的配额。
  • 响应参数 表3 响应Body参数 参数 参数类型 描述 user Object IAM用户信息。 表4 user 参数 参数类型 描述 name String IAM用户名。 links Object IAM用户的资源链接信息。 domain_id String IAM用户所属帐号ID。 enabled Boolean IAM用户是否启用。true表示启用,false表示停用,默认为true。 id String IAM用户ID。 password_expires_at String IAM用户密码过期时间(UTC时间),“null”表示密码不过期。 description String IAM用户描述信息。 pwd_status Boolean IAM用户密码状态。true:需要修改密码,false:正常。 last_project_id String IAM用户退出系统前,在控制台最后访问的项目ID。 表5 user.links 参数 参数类型 描述 self String 资源链接地址。 previous String 前一邻接资源链接地址。 next String 后一邻接资源链接地址。
  • 响应示例 状态码为 200 时: 请求成功。 { "user": { "pwd_status": true, "domain_id": "d78cbac186b744899480f25bd02...", "last_project_id": "065a7c66da0010992ff7c0031e5a5...", "name": "IAMUser", "description": "--", "password_expires_at": null, "links": { "next": null, "previous": null, "self": "https://iam.myhuaweicloud.com/v3/users/07609fb9358010e21f7bc003751..." }, "id": "7116d09f88fa41908676fdd4b039...", "enabled": true }}
  • 响应示例 状态码为 200 时: 请求成功。 { "user" : { "pwd_strength" : "Strong", "create_time" : "2020-07-08 02:19:03.0", "last_login_time" : null, "areacode" : "", "enabled" : true, "domain_id" : "086ba757f90089cf0fe5c000dbe7f...", "xuser_id" : "", "pwd_status" : false, "update_time" : null, "phone" : "-", "is_domain_owner" : false, "access_mode" : "default", "name" : "autotest1", "links" : { "next" : null, "previous" : null, "self" : "https://iam.myhuaweicloud.com/v3.0/OS-USER/users/093f75808b8089ba1f6dc000c7cac..." }, "id" : "093f75808b8089ba1f6dc000c7cac...", "xuser_type" : "", "email" : "", "description" : "aaa" }}
  • 响应参数 表3 响应Body参数 参数 参数类型 描述 user Object IAM用户信息。 表4 user 参数 参数类型 描述 enabled Boolean IAM用户是否启用。true表示启用,false表示停用,默认为true。 id String IAM用户ID。 domain_id String IAM用户所属帐号ID。 name String IAM用户名。 links Object IAM用户的资源链接信息。 xuser_id String IAM用户在外部系统中的ID。 xuser_type String IAM用户在外部系统中的类型。 areacode String IAM用户手机号的国家码。 email String IAM用户邮箱。 phone String IAM用户手机号。 pwd_status Boolean IAM用户密码状态。true:需要修改密码,false:正常。 update_time String IAM用户更新时间。 create_time String IAM用户创建时间。 last_login_time String IAM用户最后登录时间。 pwd_strength String IAM用户密码强度。结果为Low/Medium/Strong/None,分别表示密码强度低/中/高/无。 is_domain_owner Boolean IAM用户是否为帐号。 access_mode String IAM用户访问方式。 default:默认访问模式,编程访问和管理控制台访问。 programmatic:编程访问。 console:管理控制台访问。 description String IAM用户描述信息。 表5 user.links 参数 参数类型 描述 self String 资源链接地址。 previous String 前一邻接资源链接地址。 next String 后一邻接资源链接地址。
  • 响应示例 状态码为 200 时: 请求成功。 { "groups": [ { "domain_id": "d78cbac186b744899480f25bd0...", "create_time": 1578107542861, "name": "IAMGroup", "description": "", "links": { "next": null, "previous": null, "self": "https://iam.myhuaweicloud.com/v3/groups/07609e7eb200250a3f7dc003cb..." }, "id": "07609e7eb200250a3f7dc003cb7..." } ], "links": { "next": null, "previous": null, "self": "https://iam.myhuaweicloud.com/v3/users/076837351e80251c1f0fc003afe43.../groups" }}
  • 响应参数 表3 响应Body参数 参数 参数类型 描述 groups Array of objects 用户组信息列表。 links Object 资源链接信息。 表4 groups 参数 参数类型 描述 description String 用户组描述信息。 id String 用户组ID。 domain_id String 用户组所属帐号ID。 name String 用户组名称。 links Object 用户组的资源链接信息。 create_time Long 用户组创建时间。 表5 groups.links 参数 参数类型 描述 self String 资源链接地址。 previous String 前一邻接资源链接地址。 next String 后一邻接资源链接地址。 表6 links 参数 参数类型 描述 self String 资源链接地址。 previous String 前一邻接资源链接地址。 next String 后一邻接资源链接地址。
  • 响应示例 状态码为 200 时: 请求成功。 { "links": { "next": null, "previous": null, "self": "https://iam.myhuaweicloud.com/v3/groups/07609e7eb200250a3f7dc003cb7a4e2d/users" }, "users": [ { "pwd_status": true, "domain_id": "d78cbac186b744899480f25bd...", "last_project_id": "065a7c66da0010992ff7c0031e...", "name": "IAMUserA", "description": "--", "password_expires_at": null, "links": { "next": null, "previous": null, "self": "https://iam.myhuaweicloud.com/v3/users/07609fb9358010e21f7bc00375..." }, "id": "07609fb9358010e21f7bc003751c7...", "enabled": true }, { "pwd_status": true, "domain_id": "d78cbac186b744899480f25bd022...", "last_project_id": "065a7c66da0010992ff7c0031e5a...", "name": "IAMUserB", "description": "", "password_expires_at": null, "links": { "next": null, "previous": null, "self": "https://iam.myhuaweicloud.com/v3/users/076837351e80251c1f0fc003af..." }, "id": "076837351e80251c1f0fc003afe43...", "enabled": true } ]}
  • 响应参数 表3 响应Body参数 参数 参数类型 描述 links Object 用户组资源的链接。 users Array of objects IAM用户信息列表。 表4 links 参数 参数类型 描述 self String 资源链接地址。 previous String 前一邻接资源链接地址。 next String 后一邻接资源链接地址。 表5 users 参数 参数类型 描述 name String IAM用户名。 links Object IAM用户的资源链接信息。 domain_id String IAM用户所属帐号ID。 enabled Boolean 用户是否启用。true表示启用,false表示停用,默认为true。 id String IAM用户ID。 password_expires_at String 密码过期时间(UTC时间),“null”表示密码不过期。 description String IAM用户描述信息。 pwd_status Boolean 密码状态。true:需要修改密码,false:正常。 last_project_id String IAM用户退出华为云前,在控制台最后访问的项目ID。 pwd_strength String IAM用户的密码强度。high:密码强度高;mid:密码强度中等;low:密码强度低。 extra object IAM用户的其他信息。 表6 users.extra 参数 参数类型 描述 description string IAM用户描述信息。 last_project_id string IAM用户退出系统前,在控制台最后访问的项目ID。 pwd_status boolean IAM用户密码状态。true:需要修改密码,false:正常。 表7 Users.links 参数 参数类型 描述 self String 资源链接地址。 previous String 前一邻接资源链接地址。 next String 后一邻接资源链接地址。
  • 请求示例 IAM用户将自己的原始密码“IAMOriginalPassword@”修改为“IAMNewPassword@”。 POST https://iam.myhuaweicloud.com/v3/users/{user_id}/password { "user": { "password": "IAMNewPassword@", "original_password": "IAMOriginalPassword@" }}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。 X-Auth-Token 是 String URL中user_id所对应IAM用户的token(无需特殊权限)。 表3 请求Body参数 参数 是否必选 参数类型 描述 user 是 Object IAM用户信息。 表4 user 参数 是否必选 参数类型 描述 password 是 String IAM用户的新密码。 系统默认密码最小长度为6位字符,在6-32位之间支持用户自定义密码长度。 至少包含以下四种字符中的两种: 大写字母、小写字母、数字和特殊字符。 不能包含手机号和邮箱。 必须满足用户所属帐号的密码策略要求。 新密码不能与当前密码相同。 original_password 是 String IAM用户的原密码。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。 X-Auth-Token 是 String URL中user_id所对应IAM用户的token(无需特殊权限)。 表3 请求Body参数 参数 是否必选 参数类型 描述 user 是 Object IAM用户信息。 表4 user 参数 是否必选 参数类型 描述 email 否 String IAM用户的新邮箱,符合邮箱格式,长度小于等于255位。 mobile 否 String IAM用户的国家码+新手机号,手机号为纯数字,长度小于等于32位。
  • 请求示例 IAM用户修改自己的邮箱地址为“IAMEmail@huawei.com”,手机号码为“0086-123456789”。 PUT https://iam.myhuaweicloud.com/v3.0/OS-USER/users/{user_id}/info { "user": { "email": "IAMEmail@huawei.com", "mobile": "0086-123456789" }}
  • 响应参数 表5 响应Body参数 参数 参数类型 描述 user Object IAM用户信息。 表6 user 参数 参数类型 描述 name String IAM用户名。 domain_id String IAM用户所属帐号ID。 enabled Boolean IAM用户是否启用。true表示启用,false表示停用,默认为true。 id String IAM用户ID。 password_expires_at String 密码过期时间(UTC时间),“null”表示密码不过期。 description String IAM用户描述信息。 pwd_status Boolean IAM用户密码状态。true:需要修改密码,false:正常。 last_project_id String IAM用户退出系统前,在控制台最后访问的项目ID。 extra Object IAM用户的其他信息。 links Object IAM用户的资源链接信息。 表7 user.extra 参数 参数类型 描述 description String IAM用户描述信息。 pwd_status Boolean IAM用户密码状态。true:需要修改密码,false:正常。 last_project_id String IAM用户退出系统前,在控制台最后访问的项目ID。 表8 user.links 参数 参数类型 描述 self String 资源链接地址。
  • 请求示例 管理员修改名为“IAMUser”的IAM用户的密码为“IAMPassword@”。 PATCH https://iam.myhuaweicloud.com/v3/users/{user_id} { "user": { "domain_id": "d78cbac186b744899480f25bd02...", "name": "IAMUser", "password": "IAMPassword@", "enabled": true, "pwd_status": false, "description": "IAMDescription" }}
  • 响应示例 状态码为 200 时: 请求成功。 { "user": { "pwd_status": false, "description": "IAMDescription", "name": "IAMUser", "extra": { "pwd_status": false, "description": "IAMDescription", }, "enabled": true, "links": { "self": "https://iam.myhuaweicloud.com/v3/users/07609fb9358010e21f7bc003751c7..." }, "id": "07609fb9358010e21f7bc003751c7...", "domain_id": "d78cbac186b744899480f25bd02..." }}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。 X-Auth-Token 是 String 访问令牌,承载用户的身份、权限等信息。 token所需权限请参见授权项。 表3 请求Body参数 参数 是否必选 参数类型 描述 user 是 Object IAM用户信息。 表4 user 参数 是否必选 参数类型 描述 domain_id 否 String IAM用户所属帐号ID。 name 否 String IAM用户新用户名,长度1~32之间,只能包含如下字符:大小写字母、空格、数字或特殊字符(-_.)且不能以数字或空格开头。 password 否 String IAM用户密码。 系统默认密码最小长度为6位字符,在6-32位之间支持用户自定义密码长度。 至少包含以下四种字符中的两种: 大写字母、小写字母、数字和特殊字符。 不能包含手机号和邮箱。 必须满足账户设置中密码策略的要求。 新密码不能与当前密码相同。 enabled 否 Boolean 是否启用IAM用户。true为启用,false为停用,默认为true。 description 否 String IAM用户新描述信息。 pwd_status 否 Boolean IAM用户密码状态。true:需要修改密码,false:正常。
  • 响应示例 状态码为 200 时: 请求成功。 { "login_protects" : [ { "user_id" : "75226081f43d4c628c4bb88cf32e9...", "enabled" : true, "verification_method" : "email" }, { "user_id" : "16b26081f43d4c628c4bb88cf32e9...", "enabled" : true, "verification_method" : "vmfa" }, { "user_id" : "56b26081f43d4c628c4bb88cf32e9...", "enabled" : true, "verification_method" : "sms" } ] }
共100000条