云服务器内容精选

  • 响应示例 状态码: 200 请求成功 { "create_time" : "2024-07-02T09:25:17Z+0800", "creator_id" : "b4*****************************46a", "creator_name" : "l00644738", "description" : "我的工作空间", "domain_id" : "ac*****************************bf4", "domain_name" : "scc****09", "enterprise_project_id" : "", "enterprise_project_name" : "", "id" : "39*************bf", "is_view" : false, "modifier_id" : "", "modifier_name" : "", "name" : "我的工作空间", "project_id" : "15**************************da6", "project_name" : "cn-north-4", "region_id" : "cn-north-4", "update_time" : "2024-07-02T09:25:17Z+0800", "view_bind_id" : "", "view_bind_name" : "", "workspace_agency_list" : [ ] }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 id String 工作空间id create_time String 创建时间 update_time String 更新时间 name String 工作空间名称 description String 工作空间描述 creator_id String 创建人id creator_name String 创建人名称 modifier_id String 修改人id modifier_name String 修改人名称 project_id String 所属项目id project_name String 所属项目名称 domain_id String 所属租户id domain_name String 所属租户名称 enterprise_project_id String 企业项目id enterprise_project_name String 企业项目名称 is_view Boolean 是否是视图 region_id String 区域id view_bind_id String 视图绑定的空间id view_bind_name String 视图绑定的空间名称 workspace_agency_list Array of workspace_agency_list objects 仅用于视图场景,列出了该视图纳管的空间列表 表6 workspace_agency_list 参数 参数类型 描述 project_id String 委托空间所属项目id id String 空间委托id name String 空间委托名称 region_id String 委托空间所属region id workspace_attribution String THIS_ACCOUNT:本账号空间,CROSS_ACCOUNT:跨账号空间 agency_version String 用户创建托管空间时使用的 IAM 委托版本,V3或者V5 domain_id String 委托租户id domain_name String 委托租户名称 iam_agency_id String iam委托id iam_agency_name String iam委托名称 resource_spec_code Array of strings 委托空间购买版本 selected Boolean 是否被视图选中 状态码: 400 表7 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误消息 状态码: 500 表8 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误消息
  • 请求示例 创建工作空间请求体 { "name" : "我的工作空间", "region_id" : "cn-north-4", "project_name" : "cn-north-4", "enterprise_project_id" : "", "enterprise_project_name" : "", "tags" : [ { "key" : "tag1", "value" : "value1" } ], "description" : "我的工作空间" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 content-type 是 String application/json;charset=UTF-8 表3 请求Body参数 参数 是否必选 参数类型 描述 region_id 是 String 区域id enterprise_project_id 否 String 企业项目id enterprise_project_name 否 String 企业项目名称 view_bind_id 否 String 视图绑定的空间id is_view 否 Boolean 是否是视图 name 是 String 工作空间名称 description 否 String 工作空间描述 project_name 是 String 项目名称 tags 否 Array of TagsPojo objects 通过给账号下的资源添加标签,可以对资源进行自定义标记,实现资源的分类。可到标签管理服务使用可视化表格操作资源标签,并对标签进行批量编辑。 表4 TagsPojo 参数 是否必选 参数类型 描述 key 否 String 标签key value 否 String 标签value
  • 响应示例 状态码: 200 创建工作空间成功的响应参数。 { "id" : "**d05d1a553b4e188ea878e7dcb85e**", "name" : "test-workspace", "description" : "It is a test project'", "owner" : "testUser", "create_time" : 1470000020000, "update_time" : 1470000030000, "enterprise_project_id" : "***b0091-887f-4839-9929-cbc884f1e***", "enterprise_project_name" : "test-eps", "auth_type" : "public", "status" : "NORMAL", "status_info" : "" }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 owner String 创建者名称。 auth_type String 授权类型。默认值为PUBLIC。PUBLIC:租户内部公开访问。PRIVATE:仅创建者和主账号可访问。INTERNAL:创建者、主账号、指定IAM子账号可访问,需要与grants参数配合使用。 enterprise_project_id String 企业项目ID。 update_time Integer 最后修改时间,UTC。 create_time Integer 创建时间,UTC。 enterprise_project_name String 企业项目名称。 name String 工作空间名称。 description String 工作空间描述。 id String 工作空间ID,系统生成的32位UUID,不带橫线。 status String 工作空间状态。 CREATE_FAILED:创建失败。 NORMAL:状态正常。 DELETING:正在删除。 DELETE_FAILED:删除失败。 status_info String 状态描述,默认为空。该字段会补充显示状态的详细信息。如删除失败时,可通过该字段查看删除失败的原因。 grants Array of grants objects 授权用户列表。默认为空。需要与“auth_type”参数配合使用,且仅当授权类型为“INTERNAL”时才会生效。 表6 grants 参数 参数类型 描述 user_id String 用户ID,此参数与user_name必填一个。两者都填优先使用user_id。 user_name String IAM用户名称。此参数与user_id必填一个。 状态码: 400 表7 响应Body参数 参数 参数类型 描述 - String 状态码: 403 表8 响应Body参数 参数 参数类型 描述 - String 状态码: 500 表9 响应Body参数 参数 参数类型 描述 - String
  • 请求示例 创建工作空间。设置工作空间名称为“test-workspace”,授权类型为“internal”,授权的IAM用户名称为“test”。 POST https://{endpoint}/v1/{project_id}/workspaces { "name" : "test-workspace", "description" : "It is a test project", "enterprise_project_id" : "***b0091-887f-4839-9929-cbc884f1e***", "auth_type" : "internal", "grants" : [ { "user_name" : "test" } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 grants 否 Array of grants objects 授权用户列表,默认为空。需要与“auth_type”参数配合使用,且仅当授权类型为“INTERNAL”时才会生效。 auth_type 否 String 授权类型。可选值有PUBLIC、PRIVATE、INTERNAL。默认值为PUBLIC。 PUBLIC:租户内部公开访问。 PRIVATE:仅创建者和主账号可访问。 INTERNAL:创建者、主账号、指定IAM子账号可访问,需要与grants参数配合使用。 enterprise_project_id 否 String 企业项目ID。 name 是 String 工作空间名称。长度限制为4-64字符,支持中文、大小写字母、数字、中划线和下划线。同时'default'为系统预留的默认工作空间名称,用户无法自己创建名为'default'的工作空间。 description 否 String 工作空间描述,默认为空。长度限制为0-256字符。 表4 grants 参数 是否必选 参数类型 描述 user_id 否 String IAM用户ID。此参数与user_name必填一个。两者都填优先使用user_id。 user_name 否 String IAM用户名称。此参数与user_id必填一个。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 当前工作空间用户记录数 最小值:0 最大值:100 total_page Integer 查询结果总页数 最小值:0 最大值:100 data Array of Workspacebody objects 工作空间列表 表5 Workspacebody 参数 参数类型 描述 bad_record_location_name String 脏数据OBS路径 最小长度:1 最大长度:128 description String 工作空间描述 最小长度:1 最大长度:1024 eps_id String 企业项目id 最小长度:1 最大长度:128 job_log_location_name String 作业日志OBS路径 最小长度:1 最大长度:128 name String 工作空间名称 最小长度:1 最大长度:128 id String 工作空间id 最小长度:1 最大长度:128 is_default Integer 是否为默认空间,0为私有空间,1为默认空间,2为公共空间 最小长度:1 最大长度:1 owner_name String 创建者名称 最小长度:1 最大长度:128 project_id String 项目id 最小长度:1 最大长度:128 domain_id String 当前租户所属domain id 最小长度:1 最大长度:128 instance_id String 当前工作空间所属实例id 最小长度:1 最大长度:128 create_time Number 创建时间 最小长度:1 最大长度:128 create_user String 创建用户名称 最小长度:1 最大长度:128 member_num Integer 当前工作空间成员数量 最小值:0 最大值:100 update_time Number 更新时间 最小长度:1 最大长度:128 update_user String 更新用户名称 最小长度:1 最大长度:128 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最小长度:1 最大长度:1024 error_code String dayu异常码 最小长度:1 最大长度:1024 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最小长度:1 最大长度:1024 error_code String dayu异常码 最小长度:1 最大长度:1024
  • URI GET /v1/{project_id}/workspaces/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id instance_id 是 String DataArtsStudio实例id 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 分页记录数,默认20 最小值:1 最大值:100 offset 否 Integer 数据偏移量。默认0 最小值:0 最大值:2147483647
  • 请求示例 查询用户名下的所有工作空间信息 GET https://{endpoint}/v3/{project_id}/ai-mgr/workspacesRequest Header: Content-Type: application/jsonX-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
  • 响应示例 状态码: 200 请求成功 { "count" : 5, "workspaces" : [ { "workspace_id" : "0", "ma_workspace_id" : null, "project_id" : "123", "name" : "default", "description" : null, "enterprise_project_id" : "0", "enterprise_project_name" : "default", "create_time" : 1598094655508, "update_time" : 1598094655508, "owner" : "sss", "user_id" : "123", "used_flag" : null } ]}
  • URI GET /v3/{project_id}/ai-mgr/workspaces 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 iam_user_id 否 String 用户的userId,用于查询指定的的子工作空间 offset 否 Integer 查询的起始位置,取值范围为非负整数,默认为0 limit 否 Integer 每页显示的条目数量,取值范围1~100,默认为100
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 返回总条目数 workspaces Array of WorkspaceListElem objects 工作空间列表 表5 WorkspaceListElem 参数 参数类型 描述 workspace_id String 工作空间id ma_workspace_id String 对应的Modelarts工作空间的id project_id String 项目ID name String 工作空间名称 description String 工作空间描述 enterprise_project_id String 企业项目ID enterprise_project_name String 企业项目名称 create_time Long 创建时间 update_time Long 更新时间 owner String 创建者 user_id String 创建者的USER_ID used_flag String 正在被使用