云服务器内容精选

  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM Token信息,用于租户鉴权,该字段由租户请求IAM的Token接口获得。 表2 请求Body参数 参数 是否必选 参数类型 描述 workspace_name 是 String 工作共享空间名称。支持中文、英文、数字以及“_”字符,长度限制2~50个字符。 workspace_description 否 String 工作共享空间描述。支持中文、英文、数字以及“_”字符,长度限制200个字符以内。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 workspace_id String 工作共享空间ID。 workspace_name String 工作共享空间名称。 workspace_description String 工作共享空间描述。 tenant_domain_id String 华为云IAM租户账号ID。 creator String 创建人。 latest_operator String 最近修改人。 create_time String 创建时间。返回UTC时间格式字符串,格式为yyyy-MM-dd'T'HH:mm:ss'Z'。 update_time String 更新时间。返回UTC时间格式字符串,格式为yyyy-MM-dd'T'HH:mm:ss'Z'。 star Integer 工作共享空间是否置顶显示(最多可置顶4个)。 can_delete Boolean 工作共享空间是否允许删除标志位。当工作共享空间置顶显示或者该空间下存在任务时,取值为“true”,表示不可以删除。 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512 状态码: 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512
  • 响应示例 状态码: 200 请求成功。 { "workspace_id" : "3eceb0cb8b834f5bb0a66d4108c2067f", "workspace_name" : "测试空间", "workspace_description" : "空间描述", "creator" : "xxxx", "latest_operator" : "xxxx", "create_time" : "2023-05-23T07:26:28Z", "update_time" : "2023-05-23T07:26:28Z", "star" : 0, "can_delete" : false }
  • 操作步骤 登录KooMap管理控制台。 在左侧导航栏选择“工作共享空间管理”,进入“工作共享空间管理”页面。 图1 工作共享空间管理页面 在“工作共享空间管理”页面,参考表1管理工作共享空间。 表1 管理工作共享空间操作说明 操作 操作步骤 操作结果 置顶工作共享空间 选择需开启/关闭工作共享空间的置顶。 单击“置顶”下的或开启/关闭工作共享空间。 说明: 最多只能开启4个工作共享空间。 开启置顶的工作共享空间会在空间列表前端显示。 关闭置顶的工作共享空间会按照创建时间先后顺序显示。 查询工作共享空间 在右侧页面右上角区域设置过滤条件。 过滤条件包括创建工作共享空间的时间区间、工作共享空间名称。 单击或按回车键。 界面显示符合过滤条件的所有工作共享空间列表。 编辑工作共享空间 选择待编辑的工作共享空间。 单击“编辑”,修改工作共享空间名称或描述信息。 单击“确定”,完成修改。 完成工作共享空间信息的修改。 删除工作共享空间 选择待删除的工作共享空间。 单击“删除”。 单击“确定”,完成删除。 工作共享空间被删除。
  • 请求示例 置顶工作共享空间到首页。 https://{endpoint}.com/v1/kmp-control/workspaces/{workspace_id}{ "star" : 1} 修改名称和描述信息。 https://{endpoint}.com/v1/kmp-control/workspaces/{workspace_id}{ "workspace_name" : "工作空间名称_修改", "workspace_description" : "这是描述"}
  • 响应示例 状态码: 200 请求成功。 { "workspace_id" : "aa78047c2e22408597dbeb2d33295720", "workspace_name" : "工作空间名称_修改", "creator" : "xxx", "create_time" : "2022-11-07T08:28:05Z", "workspace_type" : "DATA_PROCESS", "workspace_description" : "这是描述", "star" : 1} 状态码: 400 非法请求。 { "error_code" : "400", "error_msg" : "参数不符合规范。"}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 workspace_id String 工作共享空间唯一标识。 workspace_name String 工作共享空间名称。 creator String 创建人。 create_time String 创建时间。 workspace_type String 工作共享空间类型,当前仅支持DATA_PROCESS(数据处理)。 workspace_description String 工作共享空间描述。 star Integer 是否置顶。 0:否 1:是 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 请求状态码。 最小长度:3 最大长度:36 error_msg String 错误描述。 最小长度:2 最大长度:512 状态码: 500 表6 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,用于运维人员定位请求日志。 表7 响应Body参数 参数 参数类型 描述 error_code String 请求状态码。 最小长度:3 最大长度:36 error_msg String 错误描述。 最小长度:2 最大长度:512
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM Token信息,用于租户鉴权,该字段由租户请求IAM的Token接口获得。 表3 请求Body参数 参数 是否必选 参数类型 描述 workspace_name 否 String 工作共享空间名称,支持中文、英文、数字以及“_”字符,长度限制为[1,50]。 最小长度:1 最大长度:50 workspace_description 否 String 工作共享空间描述,支持中文、英文、数字以及“_”字符,长度限制为[0,255]。 最小长度:0 最大长度:255 star 否 Integer 工作共享空间是否在首页显示。 0:不显示 1:显示