华为云用户手册

  • 请求示例 创建用户,用户名为example_user,密码为example,角色为ADMIN,邮箱为example@huawei.com,电话为12345678910,作业配额为10,作业超时时长为1天,CPU的核数配额为50,内存的配额为128GB,用户可创建的项目数为2 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/users { "name" : "example_user", "password" : "example", "role" : "ADMIN", "email" : "example@huawei.com", "phone" : "12345678910", "areacode" : "0086", "settings" : { "job_quota" : 10, "cpu_quota" : 50, "mem_quota" : 128, "job_timeout" : 1, "projects_per_user" : 2 } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限, 获取Token 接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 用户名,长度1~64之间,首位不能为数字,特殊字符只能包含下划线“_”、中划线“-”和空格 最小长度:1 最大长度:64 password 是 String 用户密码,在8-32位之间支持用户自定义密码长度,至少包含以下四种字符中的两种: 大写字母、小写字母、数字和特殊字符。 最小长度:8 最大长度:32 role 是 String 角色类型:管理员(ADMIN)、操作者(OPERATOR) 最小长度:1 最大长度:64 email 否 String 用户邮箱,需符合邮箱格式 最小长度:0 最大长度:128 phone 否 String 用户手机号,纯数字,长度小于等于32位。必须与国家码同时存在。 最小长度:5 最大长度:32 areacode 否 String 国家码。中国大陆为“0086” 最小长度:1 最大长度:10 settings 否 UserSettingDto object 用户设置 表4 UserSettingDto 参数 是否必选 参数类型 描述 job_quota 是 Integer 允许同时运行的作业数 最小值:1 最大值:100 job_timeout 是 Integer 作业执行超时时长,单位天 最小值:1 最大值:60 cpu_quota 是 Integer 作业的CPU资源配额,单位核 最小值:1 最大值:1024 mem_quota 是 Integer 作业的内存资源配额,单位GB 最小值:1 最大值:1024 projects_per_user 否 Integer 用户可创建项目数配额 最小值:0 最大值:20 缺省值:2
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 X-Delete-Now 否 Boolean 非核心项目删除立即删除标记 缺省值:false
  • URI DELETE /v1/{project_id}/eihealth-projects/{eihealth_project_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 original_password 是 String 原始密码 最小长度:0 最大长度:128 new_password 是 String 新密码 最小长度:8 最大长度:32 ticket 否 String 预验证凭证 最小长度:0 最大长度:1024
  • 请求示例 修改用户密码,修改密码Original_Password@为New_Password@ https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/users/{user_id}/password { "original_password" : "Original_Password@", "new_password" : "New_Password@", "ticket" : "ticket" }
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/data-traces 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 X-Language 是 String Locale语言信息, zh_cn返回中文,en-us返回英文 最小长度:1 最大长度:10
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer 用户数 users Array of GetUserRsp objects 用户信息列表 表4 GetUserRsp 参数 参数类型 描述 id String 用户id name String 用户名,长度4~31之间,首位不能为数字,特殊字符只能包含下划线“_”、中划线“-”和空格 role String 角色类型:管理员(ADMIN)、操作者(OPERATOR) status String 状态 email String 用户邮箱,需符合邮箱格式 phone String 用户手机号,纯数字,长度小于等于32位。必须与国家码同时存在。 areacode String 国家码。中国大陆为“0086” is_domain_owner Boolean 是否domain用户 create_time String 用户创建时间,UTC时间 pwd_status Boolean 是否需要修改密码 update_time String 更新时间,UTC时间 source String 来源,PLATFORM或者 IAM
  • 响应示例 状态码: 200 OK { "count" : 1, "users" : [ { "id" : "7116d09f88fa41908676fdd4b039...", "name" : "user", "role" : "ADMIN", "status" : "ACTIVE", "email" : "example@huawei.com", "phone" : "12345678910", "areacode" : "0086", "is_domain_owner" : true, "create_time" : "2021-01-15T02:45:38Z", "pwd_status" : true, "update_time" : "2021-01-15T02:45:38Z", "source" : "PLATFORM" } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 models Array of BaseModelDto objects 模型列表。 count Integer 模型总数。 表5 BaseModelDto 参数 参数类型 描述 name String 模型名称。 id String 模型ID。 create_time String 模型创建时间。 description String 模型描述信息。
  • 响应示例 状态码: 200 OK { "count" : 1, "models" : [ { "id" : "56e0f1b0-ac10-46a5-8fa7-b26831d7d488", "name" : "demo_name", "description" : "description", "create_time" : "2021-01-30T02:34:36Z" } ] }
  • URI GET /v1/{project_id}/base-models 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 限制量,单次查询总量,必须由数字组成,默认为100,取值范围[1,1000]。 最小值:1 最大值:1000 缺省值:100 offset 否 Integer 偏移量,查询起始偏移,必须由数字组成,默认为0,取值范围[0,100000000]。 最小值:0 最大值:100000000 缺省值:0 sort_dir 否 String 排序规则目前默认时间升序。 缺省值:ASC sort_key 否 String 排序规则目前默认时间升序,支持根据create_time排序。 缺省值:create_time
  • 响应示例 状态码: 200 OK { "path" : "2022|02|21|eiHealth-project_CloudTrace_cn-north-7_2022-02-21T02-31-09Z_a45fc9849d217b43.json.gz", "name" : "eiHealth-project_CloudTrace_cn-north-7_2022-02-21T02-31-09Z_a45fc9849d217b43.json.gz", "type" : "FILE", "size" : 438, "create_time" : "2022-02-21T02:31:09Z", "download_url" : "https://aos-eihealth-for-trace-***/***60.json.gz" }
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/project-traces/{path} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 path 是 String 审计日志全路径(路径) 最小长度:1 最大长度:2000
  • 响应示例 状态码: 200 OK { "count" : 2, "projects" : [ { "id" : "fce1376b-72f9-4d15-9f95-9b533cb96fd1", "name" : "demo-project-1", "creator" : "demo-user", "role" : "Admin", "size" : 1123243536, "status" : "ACTIVE", "tags" : [ "tag1" ], "description" : "This is demo project 1", "create_time" : "2020-09-10T10:07:17Z", "update_time" : "2020-09-10T10:07:17Z" }, { "id" : "fce1376b-72f9-4d15-9f95-9b533cb96fd2", "name" : "demo-project-2", "creator" : "demo-user", "role" : "Admin", "size" : 1123243536, "status" : "TO_BE_DELETED", "tags" : [ "tag1" ], "description" : "This is demo project 2", "create_time" : "2020-09-10T10:07:17Z", "update_time" : "2020-09-10T10:07:17Z", "delete_time" : "2020-09-10T10:07:17Z" } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer 个数 projects Array of ProjectRsp objects 项目详情列表 表4 ProjectRsp 参数 参数类型 描述 id String 项目id name String 项目名称 creator String 项目所有者 role String 当前用户在该项目上的角色 size Long 项目桶存储量 status String 项目状态 tags Array of strings 标签列表 description String 项目描述 create_time String 项目创建时间 update_time String 项目更新时间 delete_time String 请求删除时间 is_core Boolean 核心项目标记
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/project-traces 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 表2 Query参数 参数 是否必选 参数类型 描述 path 是 String 指定文件夹(路径) 最小长度:0 最大长度:2000 limit 否 Integer 限制量,单次查询总量,必须由数字组成,默认为100,取值范围[1,1000] 最小值:1 最大值:1000 缺省值:100 offset 否 Integer 偏移量,查询起始偏移,必须由数字组成,默认为0,取值范围[0,100000000] 最小值:0 最大值:100000000 缺省值:0
  • 响应示例 状态码: 200 OK { "count" : 10, "datas" : [ { "path" : "2022/02/21/eiHealth-project_CloudTrace_cn-north-7_2022-02-21T02-31-09Z_a45fc9849d217b43.json.gz", "name" : "eiHealth-project_CloudTrace_cn-north-7_2022-02-21T02-31-09Z_a45fc9849d217b43.json.gz", "type" : "FILE", "size" : 438, "create_time" : "2022-02-21T02:31:09Z", "download_url" : "https://aos-eihealth-for-trace-***/***60.json.gz" } ], "bucket_size" : 1111 }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Long 数据对象(目录,文件)总数量 datas Array of TraceDataRsp objects 数据对象列表 bucket_size Long 桶存量 表5 TraceDataRsp 参数 参数类型 描述 path String 对象全路径(项目名称:/路径) name String 名称 type String 枚举值: FILE FOLDER size Long 大小 缺省值:0 create_time String 创建时间 download_url String 下载链接
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 role 是 String 角色类型:管理员(ADMIN)、操作者(OPERATOR) 枚举值: ADMIN OPERATOR
  • URI DELETE /v1/{project_id}/eihealth-projects/{eihealth_project_id}/members/{user_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 user_id 是 String 被移除项目的用户id 最小长度:1 最大长度:128
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/transfer 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 user_id 是 String 转移用户id 最小长度:1 最大长度:64
  • 响应示例 状态码: 200 OK [ { "id" : "0era3396d980d45f1fJ3DGW345af8", "name" : "demo-user", "status" : "SUC CES S" } ] 状态码: 207 MULTI_STATUS [ { "id" : "0era3396d980d45f1fJ3DGW345af8", "name" : "demo-user", "status" : "FAILED", "failed_reason" : "Internal error." } ]
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 [数组元素] Array of BatchDeleteMemberRsp objects OK 表6 BatchDeleteMemberRsp 参数 参数类型 描述 id String 用户id name String 用户名 status String 删除结果 failed_reason String 失败原因 状态码: 207 表7 响应Body参数 参数 参数类型 描述 [数组元素] Array of BatchDeleteMemberRsp objects MULTI_STATUS 表8 BatchDeleteMemberRsp 参数 参数类型 描述 id String 用户id name String 用户名 status String 删除结果 failed_reason String 失败原因
  • 请求示例 批量移除项目成员,指定需要移除的成员的用户id https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/members/batch-delete { "members" : [ { "user_id" : "0era3396d980d45f1fJ3DGW345af8" } ] }
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/members/batch-delete 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 members 是 Array of MemberDto objects 删除用户列表 数组长度:1 - 5 表4 MemberDto 参数 是否必选 参数类型 描述 user_id 是 String 用户id 最小长度:1 最大长度:128
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 description 否 String 项目描述 最小长度:0 最大长度:1024 name 是 String 项目名称 最小长度:3 最大长度:45 tags 否 Array of strings 标签 最小长度:1 最大长度:32 数组长度:0 - 5 is_core 否 Boolean 是否核心项目 缺省值:true is_new_bucket 否 Boolean 是否新桶, 仅气象支持该字段 bucket_name 否 String 桶名, 仅气象支持该字段 最小长度:3 最大长度:63
共100000条