查询联邦学习作业列表
功能介绍
查询联邦学习作业列表
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/leagues/{league_id}/fl-jobs
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目id,最大32位,字母和数字组成 最小长度:0 最大长度:32 |
league_id |
是 |
String |
空间id,最大32位,字母和数字组成 最小长度:0 最大长度:32 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
是 |
Integer |
每页记录数,取值0-100 最小值:0 最大值:100 缺省值:10 |
offset |
是 |
Integer |
记录数偏移量 最小值:0 最大值:2147483647 缺省值:0 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户凭证 |
Content-Type |
是 |
String |
消息体的类型(格式) 缺省值:application/json |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
lists |
Array of FlJobListVo objects |
实例集合 |
total |
Long |
总记录数 |
参数 |
参数类型 |
描述 |
---|---|---|
algorithm_type |
String |
纵向联邦算法类型枚举。XG_BOOSTXGBoost,LIGHT_BGMLightGBM,LOGISTIC_REGRESSION逻辑回归,NEURAL_NETWORK神经网络,FIBINETFIBINET 枚举值:
|
approval_status |
String |
FL作业审批状态。APPROVED审批通过,APPROVING审批中,NEW新建,REJECTED驳回,REVOKED撤销 枚举值:
|
create_time |
String |
创建时间 |
creator_name |
String |
创建人名称 最小长度:0 最大长度:128 |
description |
String |
作业描述 最小长度:0 最大长度:512 |
ext |
String |
参数等额外信息 最小长度:0 最大长度:512 |
hfl_platform_type |
String |
联邦学习运行平台枚举值。LOCAL本地 枚举值:
|
hfl_type |
String |
FL作业类型枚举。TRAIN训练,EVALUATE评估 枚举值:
|
is_single_predict |
Boolean |
单方还是双方预测 |
job_id |
String |
作业id 最小长度:0 最大长度:32 |
job_name |
String |
作业名称 最小长度:0 最大长度:128 |
job_type |
String |
作业类型。SQL联合SQL分析,HFL横向联邦学习,VFL纵向联邦学习,PREDICT预测,DATA_EXCHANGE数据交换 枚举值:
|
learning_task_type |
String |
纵向联邦任务类型。CLASSIFICATION分类,REGRESSION拟合 枚举值:
|
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
请求示例
查询联邦学习作业列表
get /v1/{project_id}/leagues/{league_id}/fl-jobs?offset=0&limit=10
响应示例
状态码: 200
保存联邦学习作业成功
{ "total" : 2, "lists" : [ { "job_id" : "25e5a949eb1c44528b2881448a1db5aa", "job_name" : "ss", "job_type" : "VFL", "creator_name" : "zhangsan", "create_time" : "2022-10-26T09:04:50.000+00:00", "hfl_type" : "TRAIN", "hfl_platform_type" : "LOCAL", "algorithm_type" : "FIBINET" }, { "description" : "cc", "job_id" : "1aec7ad4ee834e3c9f08adefb7ab2fe8", "job_name" : "featuretest", "job_type" : "VFL", "creator_name" : "zhangsan", "create_time" : "2022-10-19T06:45:37.000+00:00", "hfl_type" : "TRAIN", "hfl_platform_type" : "LOCAL", "algorithm_type" : "LOGISTIC_REGRESSION" } ] }
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.tics.v1.region.TicsRegion; import com.huaweicloud.sdk.tics.v1.*; import com.huaweicloud.sdk.tics.v1.model.*; public class ListFlJobSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); TicsClient client = TicsClient.newBuilder() .withCredential(auth) .withRegion(TicsRegion.valueOf("<YOUR REGION>")) .build(); ListFlJobRequest request = new ListFlJobRequest(); request.withLimit(<limit>); request.withOffset(<offset>); try { ListFlJobResponse response = client.listFlJob(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdktics.v1.region.tics_region import TicsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdktics.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = TicsClient.new_builder() \ .with_credentials(credentials) \ .with_region(TicsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListFlJobRequest() request.limit = <limit> request.offset = <offset> response = client.list_fl_job(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" tics "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/tics/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/tics/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/tics/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := tics.NewTicsClient( tics.TicsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListFlJobRequest{} request.Limit = int32(<limit>) request.Offset = int32(<offset>) response, err := client.ListFlJob(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
保存联邦学习作业成功 |
401 |
操作无权限 |
500 |
内部服务器错误 |