华为云用户手册

  • 请求示例 更新项目,修改项目描述、标签,将项目更新为可用状态 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}{ "description" : "this is a demo project", "status" : "ACTIVE", "tags" : [ "tag" ]}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限, 获取Token 接口响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 description 否 String 项目描述。 最小长度:0 最大长度:1024 status 否 String 项目状态。 枚举值: ACTIVE INACTIVE tags 否 Array of strings 项目标签。支持添加0~5个标签。 最小长度:1 最大长度:32 is_core 否 Boolean 是否为核心项目标记。 storage_quota 否 Long 项目数据容量配额。-1表示无容量限制。 取值范围:1073741824-11258999068426240。 单位:字节。
  • URI DELETE /v1/{project_id}/eihealth-projects/{eihealth_project_id}/members/{user_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体 平台项目ID,您可以在 EIHealth 平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 user_id 是 String 被移除项目的用户id 最小长度:1 最大长度:128
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 role 是 String 项目角色。枚举值:Administrator、Developer、Uploader、Viewer 枚举值: Administrator Developer Uploader Viewer
  • URI PUT /v1/{project_id}/eihealth-projects/{eihealth_project_id}/members/{user_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 user_id 是 String 更新或者添加项目成员角色的用户id 最小长度:1 最大长度:128
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/transfer 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 user_id 是 String 转移用户id 最小长度:1 最大长度:64
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 id String 项目id name String 项目名称 obs_bucket_name String 项目桶名 swr_namespace String 项目组织名 creator String 项目所有者 role String 当前用户在该项目上的角色 roles Array of ProjectRoleRsp objects 项目角色列表 size Long 项目桶存储量 status String 项目状态 tags Array of strings 标签列表 description String 项目描述 create_time String 项目创建时间 update_time String 项目更新时间 delete_time String 请求删除时间 is_core Boolean 核心项目标记 storage_quota Long 项目数据容量配额,-1表示无容量限制 表4 ProjectRoleRsp 参数 参数类型 描述 role_type String 项目角色类型 users Array of BindUserRsp objects 项目成员列表 表5 BindUserRsp 参数 参数类型 描述 id String 项目成员用户id name String 项目成员用户名
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 X-Bucket-Name 否 String X-Bucket-Name 最小长度:1 最大长度:128 X-Namespace-Name 否 String X-Namespace 最小长度:1 最大长度:128
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。
  • 响应示例 状态码: 200 OK { "id" : "fce1376b-72f9-4d15-9f95-9b533cb96fda", "name" : "demo-project", "obs_bucket_name" : "eihealth-demo-project-sjdj3", "swr_namespace" : "eihealth-demo-project-sjdj3", "tags" : [ "tag1" ], "description" : "This is demo project", "creator" : "demo-user", "role" : "Admin", "roles" : [ { "role_type" : "Admin", "users" : [ { "id" : "adb1376b-72f9-4d15-9f95-9b533cb96dce", "name" : "demo-user" } ] } ], "size" : 1123243535, "status" : "TO_BE_DELETED", "update_time" : "2020-09-10T10:07:17Z", "create_time" : "2020-09-10T10:07:17Z", "delete_time" : "2020-09-10T10:07:17Z" }
  • URI POST /v1/{project_id}/system/computing-resources/{id}/stop 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 id 是 String 计算资源id 最小长度:1 最大长度:128 表2 Query参数 参数 是否必选 参数类型 描述 force 否 Boolean 是否强制关闭,默认为false 缺省值:false
  • 响应参数 状态码: 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 失败原因
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 members 是 Array of MemberDto objects 删除用户列表 表4 MemberDto 参数 是否必选 参数类型 描述 user_id 是 String 用户id。支持删除1~5个。 最小长度:1 最大长度:128
  • 响应示例 状态码: 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."} ]
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/members/batch-delete 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128
  • 请求示例 批量移除项目成员,指定需要移除的成员的用户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}/system/computing-resources/{id}/reboot 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 id 是 String 计算资源id 最小长度:1 最大长度:128 表2 Query参数 参数 是否必选 参数类型 描述 force 否 Boolean 是否强制重启,默认为false 缺省值:false
  • 响应示例 状态码: 200 OK { "count" : 1, "flavors" : [ { "code" : "code", "name" : "name", "ram" : 8192, "vcpus" : 4, "max_rate" : 8000, "min_rate" : 2400, "max_pps" : 800000, "sold_out" : false, "cpu_detail" : "Intel Xeon E5-2667 V4 (2*8core* 3.2 GHz)", "disk_detail" : "SAS SSD:2*800G Raid 1 + NVMe SSD Card1.6T", "memory_detail" : "256GB DDR4 RAM (GB)", "netcard_detail" : "2 x 2*10GE", "cpu_arch" : "x86_64" } ]}
  • URI GET /v1/{project_id}/system/computing-resources/flavors 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 表2 Query参数 参数 是否必选 参数类型 描述 availability_zone_id 否 String 可用区 最小长度:1 最大长度:64
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数 flavors Array of ComputingResourceFlavorsRsp objects 规格列表 表5 ComputingResourceFlavorsRsp 参数 参数类型 描述 code String 规格编码 name String 规格名称 最大长度:64 ram Long 内存 vcpus String vCPUs max_rate String 最大带宽 min_rate String 基准带宽 max_pps String 最大收发包能力 sold_out Boolean 是否售罄 cpu_detail String CPU物理规格描述信息 disk_detail String 磁盘物理规格描述信息 memory_detail String 内存物理规格描述信息 netcard_detail String 网卡物理规格描述信息 cpu_arch String 裸金属服务器的CPU架构类型
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer 总数 resources Array of ComputingResourceRsp objects 计算资源列表 表4 ComputingResourceRsp 参数 参数类型 描述 id String 实例ID resource_id String 资源ID name String 实例名称 spec ComputingSpecDto object 规格信息 system_disk DiskDto object 系统盘 data_disks Array of DiskDto objects 数据盘 image ImageDto object 系统镜像 charge_mode String 计费模式,取值范围: 1(包年包月) 2(按需) create_time String 购买时间 failure_reason String 失败原因 status String 状态 availability_zone_id String 可用区 schedulable Boolean 资源是否可调度 node_labels Array of strings 计算节点标签列表 表5 ComputingSpecDto 参数 参数类型 描述 code String 规格编号 最大长度:64 name String 规格名称 最大长度:64 ram Long 内存 vcpus String vCPUs max_rate String 最大带宽 min_rate String 基准带宽 max_pps String 最大收发包能力 表6 DiskDto 参数 参数类型 描述 type String 磁盘类型 space String 磁盘大小 表7 ImageDto 参数 参数类型 描述 type String 镜像类型 version String 镜像版本
  • 响应示例 状态码: 200 OK { "count" : 1, "resources" : [ { "id" : "baabcb56-5bb6-11eb-8a0d-.....", "spec" : { "code" : "eihealth.xxx.spec.xxx.xxx", "name" : "xxx", "ram" : 8192, "vcpus" : "a", "max_rate" : 8000, "min_rate" : 2400, "max_pps" : 800000 }, "system_disk" : { "type" : "SAS", "space" : 40 }, "data_disks" : [ { "type" : "SAS", "space" : 100 } ], "image" : { "type" : "CentOS", "version" : 1.0 }, "charge_mode" : 2, "create_time" : "2021-02-01T14:25:50Z", "status" : "ACTIVE", "availability_zone_id" : "cn-north-7c", "schedulable" : true, "node_labels" : [ "label" ] } ] }
  • 响应示例 状态码: 200 OK { "count": 1, "flavors": [ { "code": " eihealth.dbm.spec.basic", "name": "string", "cpu": 4, "ram": 8, "max_connections": 2500, "disk_space": 1000, "sold_out": true } ]}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 spec_code 是 String 规格编码,取值如下: eihealth.dbm.spec.standard.200g eihealth.dbm.spec.standard.500g eihealth.dbm.spec.standard.1000g disk_space 否 Integer 磁盘存储空间,该字段暂不生效 最小值:40 最大值:1000 disk_encrypt 是 Boolean 磁盘是否加密,该参数当前仅支持false
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 job_retain_number 是 Integer 作业保存条数 最小值:10000 最大值:10000000
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer 个数 flavors Array of DatabaseFlavorRsp objects 规格列表 表4 DatabaseFlavorRsp 参数 参数类型 描述 code String 规格编号 name String 规格名称 cpu Integer 核数 ram Integer 内存 max_connections Integer 最大连接数 disk_space Integer 存储空间 sold_out Boolean 是否售罄
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer 总数 resources Array of DatabaseResourceRsp objects 数据库资源列表 表4 DatabaseResourceRsp 参数 参数类型 描述 id String 实例ID resource_id String 资源ID spec DatabaseSpecDto object 规格信息 disk DatabaseDiskDto object 磁盘信息 charge_mode String 计费模式,取值范围: 1(包年包月) 2(按需) period_num Integer 购买周期 create_time String 购买时间,UTC时间 failure_reason String 失败原因 status String 枚举值: DEPLOYING NORMAL UPDATINTG ABNORMAL FREEZE DELETING 表5 DatabaseSpecDto 参数 参数类型 描述 code String 规格编号 最大长度:64 name String 规格名称 最大长度:64 表6 DatabaseDiskDto 参数 参数类型 描述 type String 磁盘类型 space Integer 磁盘大小,单位GB encrypt Boolean 是否加密 used Double 磁盘已使用量,单位GB
  • 响应示例 状态码: 200 OK { "count" : 0, "resources" : [ { "id" : "string", "resource_id" : "string", "spec" : { "code" : "string", "name" : "string" }, "disk" : { "type" : "string", "space" : 0, "encrypt" : true, "used" : 0 }, "charge_mode" : "string", "period_num" : 0, "create_time" : "2021-09-02T11:51:30Z", "status" : "DEPLOYING" } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 标签名称 最小长度:1 最大长度:32 description 否 String 标签描述 最小长度:0 最大长度:1024
共100000条