华为云用户手册

  • 请求参数 表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文件的内容。
  • URI HEAD /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 时: 请求成功。 { "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" } }
  • 请求参数 表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"至少填写一个。
  • 请求示例 创建一个名为“cn-north-1_IAMProject”且在华北-北京一的项目,项目所属账号ID是d78cbac186b744899480f25bd0... POST https://iam.myhuaweicloud.com/v3/projects { "project": { "name": "cn-north-1_IAMProject", "parent_id": "aa2d97d7e62c4b7da3ffdfc11551f878", "domain_id": "d78cbac186b744899480f25bd0...", "description": "IAMDescription" } }
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。 X-Auth-Token 是 String 访问令牌,承载用户的身份、权限等信息。 token所需权限请参见授权项。 表2 请求Body参数 参数 是否必选 参数类型 描述 project 是 Object 项目信息。 表3 project 参数 是否必选 参数类型 描述 name 是 String 项目名称。必须以存在的"区域ID_"开头,长度小于等于64。例如区域“华北-北京一”的区域ID为“cn-north-1”,在其下创建项目时,项目名应填“cn-north-1_IAMProject” parent_id 是 String 区域对应的项目ID,例如区域“华北-北京一”区域对应的项目ID为:04dd42abe48026ad2fa3c01ad7fa.....,获取方式请参见:获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 domain_id 否 String 项目所属账号ID。 description 否 String 项目描述信息,长度小于等于255字符。
  • 响应参数 表4 响应Body参数 参数 参数类型 描述 project Object 项目信息。 表5 project 参数 参数类型 描述 is_domain Boolean false. description String 项目描述信息。 links Object 项目的资源链接。 enabled Boolean 项目是否可用。 id String 项目ID。 parent_id String 区域对应的项目ID,例如区域“华北-北京一”区域对应的项目ID为:04dd42abe48026ad2fa3c01ad7fa.....。 domain_id String 项目所属账号ID。 name String 项目名称。 表6 project.links 参数 参数类型 描述 self String 资源链接地址。
  • 响应示例 状态码为 201 时: 创建成功。 { "project": { "is_domain": false, "description": "IAMDescription", "links": { "self": "https://iam.myhuaweicloud.com/v3/projects/07707ab14980265e2f5fc003a021bbc3" }, "enabled": true, "id": "07707ab14980265e2f5fc003a021bbc3", "parent_id": "aa2d97d7e62c4b7da3ffdfc11551f878", "domain_id": "d78cbac186b744899480f25bd02...", "name": "cn-north-1_IAMProject" } }
  • 响应示例 状态码: 403 请求未授权。 示例 1 { "error_code" : "IAM.0002", "error_msg" : "You are not authorized to perform the requested action." } 示例 2 { "error_code" : "IAM.0003", "error_msg" : "Policy doesn't allow %(actions)s to be performed." } 状态码: 500 Internal Server Error { "error_code" : "IAM.0006", "error_msg" : "An unexpected error prevented the server from fulfilling your request." }
  • URI DELETE /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。
  • 请求示例 修改SAML身份提供商为不启用。 PATCH https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers/{id} { "identity_provider": { "description": "Stores ACME identities.", "enabled": false } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。 X-Auth-Token 是 String 访问令牌,承载用户的身份、权限等信息。 token所需权限请参见授权项。 表3 请求Body参数 参数 是否必选 参数类型 描述 identity_provider 是 Object 身份提供商信息。 表4 identity_provider 参数 是否必选 参数类型 描述 description 否 String 身份提供商描述信息。 enabled 否 Boolean 身份提供商是否启用,true为启用,false为停用,默认为false。
  • 响应示例 状态码为 200 时: 请求成功。 { "identity_provider": { "remote_ids": [], "enabled": false, "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 GET /v3/domains/{domain_id}/config/security_compliance/{option} 表1 路径参数 参数 是否必选 参数类型 描述 domain_id 是 String 待查询的账号ID,获取方式请参见:获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 option 是 String 查询条件。该字段内容为:password_regex或password_regex_description。 password_regex:密码强度策略的正则表达式;password_regex_description:密码强度策略的描述。 取值范围: password_regex password_regex_description
  • 响应示例 状态码为 200 时: 请求成功。 示例1:option为password_regex。 示例2:option为password_regex_description。 示例 1 { "config": { "password_regex": "^(?![A-Z]*$)(?![a-z]*$)(?![\\d]*$)(?![^\\W]*$)\\S{6,32}$" } } 示例 2 { "config": { "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." } }
  • 请求示例 按照条件查询账号密码强度策略,option为password_regex。 GET https://iam.myhuaweicloud.com/v3/domains/{domain_id}/config/security_compliance/password_regex 按照条件查询账号密码强度策略,option为password_regex_description。 GET https://iam.myhuaweicloud.com/v3/domains/{domain_id}/config/security_compliance/password_regex_description
  • 响应参数 表3 响应Body参数 参数 参数类型 描述 config Object 配置信息。 表4 config 参数 参数类型 描述 password_regex String 密码强度策略的正则表达式。(当option为password_regex时返回) password_regex_description String 密码强度策略的描述。(当option为password_regex_description时返回)
  • 响应示例 状态码为 300 时: 查询成功。(Multiple Choices) { "versions": { "values": [ { "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" } ] } }
  • 响应参数 表1 响应Body参数 参数 参数类型 描述 versions Object Keystone API的版本信息。 表2 versions 参数 参数类型 描述 values Array of objects Keystone API的版本信息列表。 表3 versions.values 参数 参数类型 描述 status String 版本状态。 updated String 最后更新时间。 links Array of objects 版本的资源链接信息 id String 版本号,如v3.6。 media-types Array of objects 支持的消息格式。 表4 versions.values.links 参数 参数类型 描述 rel String 链接类型。self:自助链接包含了版本链接的资源。bookmark:书签链接提供了一个永久资源的永久链接。alternate:备用链接包含了资源的替换表示形式。 href String 资源链接地址。 表5 versions.values.media-types 参数 参数类型 描述 type String 媒体类型。 base String 基础类型。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。 X-Auth-Token 是 String 访问令牌,承载用户的身份、权限等信息。 token所需权限请参见授权项。 表3 请求Body参数 参数 是否必选 参数类型 描述 project 是 Object 项目信息。 表4 project 参数 是否必选 参数类型 描述 status 是 String 项目的状态信息,参数的值为"suspended"或"normal"。 status值为"suspended"时,会将项目设置为冻结状态。 status值为"normal"时,会将项目设置为正常(解冻)状态。 取值范围: suspended normal
  • URI PUT /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,获取方式请参见:获取权限ID。
  • URI PUT /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。
  • URI DELETE /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。
  • URI PUT /v3/groups/{group_id}/users/{user_id} 表1 路径参数 参数 是否必选 参数类型 描述 group_id 是 String 用户组ID,获取方式请参见:获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 user_id 是 String 待添加的IAM用户ID,获取方式请参见:获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。
  • 请求示例 修改用户组的名称为“IAMGroup”,描述修改为“IAMDescription”。 PATCH https://iam.myhuaweicloud.com/v3/groups/{group_id} { "group": { "description": "IAMDescription", "domain_id": "d78cbac186b744899480f25bd02...", "name": "IAMGroup" } }
  • 响应示例 状态码为 200 时: 请求成功。 { "group": { "description": "IAMDescription", "links": { "self": "https://iam.myhuaweicloud.com/v3/groups/077a4da48a00251f3f9dc0032103400f" }, "id": "077a4da48a00251f3f9dc0032103400f", "create_time": 1578969360636, "domain_id": "d78cbac186b744899480f25bd...", "name": "IAMGroup" } }
  • 响应参数 表5 响应Body参数 参数 参数类型 描述 group Object 用户组信息。 表6 group 参数 参数类型 描述 description String 用户组描述信息。 id String 用户组ID。 domain_id String 用户组所属账号ID。 name String 用户组名。 links Object 用户组的资源链接信息。 create_time Long 用户组创建时间。 表7 group.links 参数 参数类型 描述 self String 资源链接地址。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8” X-Auth-Token 是 String 访问令牌,承载用户的身份、权限等信息。 token所需权限请参见授权项。 表3 请求Body参数 参数 是否必选 参数类型 描述 group 是 Object 用户组信息。 表4 group 参数 是否必选 参数类型 描述 description 否 String 用户组描述信息,长度小于等于255字符。name与description至少填写一个。 domain_id 否 String 用户组所属账号ID,获取方式请参见:获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 name 否 String 用户组名,长度1~128字符。name与description至少填写一个。
共100000条