package kuscia.proto.api.v1alpha1.kusciaapi
Get desktop application:
View/edit binary Protocol Buffers messages
rpc GenerateKeyCerts (, )
certificate.proto:25message
certificate.proto:28string common_name = 1
Common Name, required
string country = 2
Country, optional
string organization = 3
Organization, optional
string organization_unit = 4
Organization Unit, optional
string locality = 5
Locality, optional
string province = 6
Province, optional
string street_address = 7
Street Address, optional
int64 duration_sec = 8
Valid Duration Seconds, optional, from now, default: 1 day
string key_type = 9
Key Type, Enum: [PKCS#1, PKCS#8], optional, default: PKCS#1
Subject Alt Name, optional, example: IP:127.0.0.1,IP:2.2.2.2,DNS:localhost,DNS:www.example.com string san = 10; Extensions, optional map<string, string> extensions = 11;
message
certificate.proto:53optional status = 1
string key = 2
The generate private key.Default PKCS#1. Base64 Encoded.
repeated string cert_chain = 3
The cert chain of generate cert file.The first is the generate cert, The last is domain root ca cert.Base64 Encoded.
message
domaindatagrant.proto:137optional header = 1
repeated data = 2
message
domaindatagrant.proto:142optional status = 1
repeated data = 2
message
domaindatagrant.proto:41optional header = 1
string domaindatagrant_id = 2
string domaindata_id = 3
string grant_domain = 4
optional limit = 5
map<string, string> description = 6
string signature = 7
string domain_id = 8
message
domaindatagrant.proto:52optional status = 1
optional data = 2
message
domaindatagrant.proto:113optional header = 1
string domain_id = 2
string domaindatagrant_id = 3
message
domaindatagrant.proto:119optional status = 1
message
domaindatagrant.proto:147optional header = 1
optional data = 2
message
domaindatagrant.proto:158optional status = 1
optional data = 2
message
domaindatagrant.proto:126optional header = 1
string domain_id = 2
string domaindatagrant_id = 3
message
domaindatagrant.proto:132optional status = 1
optional data = 2
message
domaindatagrant.proto:100optional header = 1
string domaindatagrant_id = 2
string domaindata_id = 3
string grant_domain = 4
optional limit = 5
map<string, string> description = 6
string signature = 7
string domain_id = 8
message
domaindatagrant.proto:111optional status = 1
message
domaindata.proto:145optional header = 1
repeated data = 2
message
domaindata.proto:150optional status = 1
optional data = 2
rpc CreateDomainData (, )
domaindata.proto:25message
domaindata.proto:38optional header = 1
string domaindata_id = 2
Optional, the domaindata_id would be generated by server if the domaindata_id is empty. The unique identity of domaindata,it couldn't duplicate in the same domain.
string name = 3
The human readable, it could duplicate in the domain.
string type = 4
Enum: table,model,rule,report,unknown
string relative_uri = 5
The relative_uri is relative to the datasource URI, The datasourceURI appends relative_uri is the domaindataURI. e.g. the relative_uri is "train/table.csv" the URI of datasource is "/home/data" the URI of domaindata is "/home/data/train/table.csv"
string domain_id = 6
Domain_id is the unique identity of the domain. the domaindata is belong to this domain.
string datasource_id = 7
Optional, server would use default datasource if datasource_id is empty. The datasource is where the domain is stored.
map<string, string> attributes = 8
Optional, The attributes of the domaindata, this field use as a extra field, User could set this field to any data what they need.
optional partition = 9
Optional, Partition not support now
repeated columns = 10
This field must be set if the type is 'table', the columns describe the table's schema information.
string vendor = 11
Optional , The vendor is the one who outputs the domain data, it may be the SecretFlow engine, another vendor's engine, or manually registered. it's could be manual, secretflow or other vendor string.
FileFormat file_format = 12
file-format only takes effect when the data source type is localfs or oss. default value is csv
message
domaindata.proto:72optional status = 1
optional data = 2
rpc DeleteDomainData (, )
domaindata.proto:29message
domaindata.proto:119optional header = 1
string domain_id = 2
domaindata id
string domaindata_id = 3
message
domaindata.proto:126optional status = 1
rpc ListDomainData (, )
domaindata.proto:35message
domaindata.proto:155optional header = 1
optional data = 2
message
domaindata.proto:160optional status = 1
optional data = 2
rpc QueryDomainData (, )
domaindata.proto:31message
domaindata.proto:130optional header = 1
optional data = 2
message
domaindata.proto:135optional status = 1
optional data = 2
rpc UpdateDomainData (, )
domaindata.proto:27message
domaindata.proto:84UpdateDomainDataRequest : The field would not be updated if the field not set in the UpdateDomainDataRequest or the field is invalid.
optional header = 1
string domaindata_id = 2
Mandatory, The domaindata_id indicate which domaindata would be updated.
string name = 3
The human-readable name
string type = 4
Enum: table,model,rule,report,unknown
string relative_uri = 5
The relative_uri is relative to the datasource URI, The datasourceURI appends relative_uri is the domaindataURI. e.g. the relative_uri is "train/table.csv" the URI of datasource is "/home/data" the URI of domaindata is "/home/data/train/table.csv"
string domain_id = 6
Mandatory, The domain_id indicate which domain's domaindata would be updated.
string datasource_id = 7
The datasource is where the domain is stored.
map<string, string> attributes = 8
The attributes of the domaindata, this field use as a extra field, User could set this field to any data that they need.
optional partition = 9
Partition not support now
repeated columns = 10
The columns describe the table's schema information.
string vendor = 11
Optional , The vendor is the one who outputs the domain data, it may be the SecretFlow engine, another vendor's engine, or manually registered. it's could be manual, secretflow or other vendor string.
FileFormat file_format = 12
file-format only takes effect when the data source type is localfs or oss. default value is csv
message
domaindata.proto:115optional status = 1
message
domaindatasource.proto:99optional header = 1
repeated data = 2
message
domaindatasource.proto:104optional status = 1
optional data = 2
message
domaindatasource.proto:38optional header = 1
string domain_id = 2
string datasource_id = 3
string type = 4
optional string name = 5
optional info = 6
optional string info_key = 7
optional bool access_directly = 8
message
domaindatasource.proto:49optional status = 1
optional data = 2
message
domaindatasource.proto:73optional header = 1
string domain_id = 2
string datasource_id = 3
message
domaindatasource.proto:79optional status = 1
message
domaindatasource.proto:109optional header = 1
string domain_id = 2
couldn't be empty
message
domaindatasource.proto:115optional status = 1
optional data = 2
message
domaindatasource.proto:83optional header = 1
string domain_id = 2
string datasource_id = 3
message
domaindatasource.proto:89optional status = 1
optional data = 2
message
domaindatasource.proto:58optional header = 1
string domain_id = 2
string datasource_id = 3
string type = 4
optional string name = 5
optional info = 6
optional string info_key = 7
optional bool access_directly = 8
message
domaindatasource.proto:69optional status = 1
message
domain_route.proto:152optional header = 1
repeated route_keys = 2
message
domain_route.proto:162optional status = 1
optional data = 2
message
domain_route.proto:31optional header = 1
string authentication_type = 2
string destination = 3
optional endpoint = 4
string source = 5
optional token_config = 6
optional
optional mtls_config = 7
optional
optional transit = 8
Transit entity. If transitMethod is THIRD-DOMAIN, requests from source to destination need to be transferred through a third party, domain field must be set. If transitMethod is REVERSE-TUNNEL, requests from source to destination need to be transferred through local gateway chunked transfer encoding. optional
optional body_encryption = 9
optional
message
domain_route.proto:104optional status = 1
optional data = 2
message
domain_route.proto:113optional header = 1
string destination = 3
string source = 2
message
domain_route.proto:119optional status = 1
message
domain_route.proto:123optional header = 1
string destination = 2
string source = 3
message
domain_route.proto:129optional status = 1
optional data = 2
service DomainService
domain.proto:24rpc BatchQueryDomain (, )
domain.proto:33message
domain.proto:100optional header = 1
repeated string domain_ids = 2
message
domain.proto:105optional status = 1
optional data = 2
rpc CreateDomain (, )
domain.proto:25message
domain.proto:36optional header = 1
string domain_id = 2
string role = 3
string cert = 4
optional auth_center = 5
string master_domain_id = 6
message
domain.proto:45optional status = 1
rpc DeleteDomain (, )
domain.proto:31message
domain.proto:49optional header = 1
string domain_id = 2
message
domain.proto:54optional status = 1
rpc QueryDomain (, )
domain.proto:27message
domain.proto:58optional header = 1
string domain_id = 2
message
domain.proto:63optional status = 1
optional data = 2
rpc UpdateDomain (, )
domain.proto:29message
domain.proto:87optional header = 1
string domain_id = 2
string role = 3
string cert = 4
optional auth_center = 5
string master_domain_id = 6
message
domain.proto:96optional status = 1
service HealthService
health.proto:24rpc healthZ (, )
health.proto:25message
health.proto:28optional header = 1
message
health.proto:32optional status = 1
optional data = 2
service JobService
job.proto:24rpc ApproveJob (, )
job.proto:43message
job.proto:178string job_id = 1
ApproveResult result = 2
string reason = 3
message
job.proto:184optional status = 1
optional data = 2
rpc BatchQueryJobStatus (, )
job.proto:29message
job.proto:264optional header = 1
repeated string job_ids = 2
message
job.proto:269optional status = 1
optional data = 2
rpc CancelJob (, )
job.proto:37message
job.proto:144optional header = 1
string job_id = 2
string reason = 3
message
job.proto:150optional status = 1
optional data = 2
rpc CreateJob (, )
job.proto:25message
job.proto:46optional header = 1
string job_id = 2
string initiator = 3
发起方
int32 max_parallelism = 4
并发度
repeated tasks = 5
任务参数
map<string, string> custom_fields = 6
自定义参数
message
job.proto:55optional status = 1
optional data = 2
rpc DeleteJob (, )
job.proto:39message
job.proto:85optional header = 1
string job_id = 2
message
job.proto:90optional status = 1
optional data = 2
rpc QueryJob (, )
job.proto:27message
job.proto:159optional header = 1
string job_id = 2
message
job.proto:164optional status = 1
optional data = 2
rpc RestartJob (, )
job.proto:33message
job.proto:129optional header = 1
string job_id = 2
string reason = 3
message
job.proto:135optional status = 1
optional data = 2
rpc StopJob (, )
job.proto:31message
job.proto:99optional header = 1
string job_id = 2
string reason = 3
message
job.proto:105optional status = 1
optional data = 2
rpc SuspendJob (, )
job.proto:35message
job.proto:114optional header = 1
string job_id = 2
string reason = 3
message
job.proto:120optional status = 1
optional data = 2
rpc WatchJob (, stream )
job.proto:41message
job.proto:293optional header = 1
int64 timeout_seconds = 2
message
job.proto:298EventType type = 1
optional object = 2
service ServingService
serving.proto:24message
serving.proto:85optional header = 1
repeated string serving_ids = 2
message
serving.proto:90optional status = 1
optional data = 2
rpc CreateServing (, )
serving.proto:25message
serving.proto:36optional header = 1
string serving_id = 2
string serving_input_config = 3
string initiator = 4
repeated parties = 5
message
serving.proto:44optional status = 1
rpc DeleteServing (, )
serving.proto:31message
serving.proto:76optional header = 1
string serving_id = 2
message
serving.proto:81optional status = 1
rpc QueryServing (, )
serving.proto:27message
serving.proto:48optional header = 1
string serving_id = 2
message
serving.proto:53optional status = 1
optional data = 2
rpc UpdateServing (, )
serving.proto:29message
serving.proto:65optional header = 1
string serving_id = 2
string serving_input_config = 3
repeated parties = 4
message
serving.proto:72optional status = 1
message
job.proto:189Used in:
string job_id = 1
Used in:
APPROVE_RESULT_UNKNOWN = 0
APPROVE_RESULT_ACCEPT = 1
APPROVE_RESULT_REJECT = 2
message
domain.proto:129Used in: , ,
string authentication_type = 1
Token
string token_gen_method = 2
UID-RSA-GEN
Token = 0
MTLS = 1
message
domain.proto:110Used in:
repeated domains = 1
message
domain_route.proto:167Used in:
repeated routes = 1
message
job.proto:274Used in:
repeated jobs = 1
message
serving.proto:95Used in:
repeated servings = 1
message
domain_route.proto:100Used in: ,
string algorithm = 1
AES = 0
SM4 = 1
message
job.proto:155Used in:
string job_id = 1
message
domaindatagrant.proto:57Used in:
string domaindatagrant_id = 1
id of created domaindatagrant
message
domaindata.proto:77Used in:
string domaindata_id = 1
id of created datasource
message
domaindatasource.proto:54Used in:
string datasource_id = 1
message
domain_route.proto:109Used in:
string name = 1
message
job.proto:60Used in:
string job_id = 1
message
domaindatasource.proto:150Used in: , ,
optional localfs = 1
there is only one of the localfs or the oss in the DataSourceInfo LocalDataSourceInfo is exist only if the type of datasource is localfs OssDataSourceInfo is exist only if the type of datasource is oss
optional oss = 2
aws s3 object storage service
optional database = 3
Relational database info, such as Mysql/oracle/postgres
optional odps = 4
aliyun odps(MaxCompute)
message
domaindatasource.proto:191datasource info for mysql/oracle/postgres
Used in:
string endpoint = 1
endpoint for database, such as localhost:3306
string user = 2
user name of account to access database
string password = 3
password of account to access database
string database = 4
database name
message
job.proto:95Used in:
string job_id = 1
message
domain.proto:121Used in:
string token = 1
deploy token
string state = 2
used or unused
string last_transition_time = 3
message
domain.proto:114Used in:
string domain_id = 1
string role = 2
string cert = 3
repeated node_statuses = 4
message
domaindata.proto:178Used in: ,
string domaindata_id = 1
domaindata_id is the identification of domaindata, it couldn't duplicate in the same domain.
string name = 2
The human readable, it could duplicate in the domain.
string type = 3
DomainData type , Enum: table,model,rule,report,unknown
string relative_uri = 4
The relative_uri is relative to the datasource URI, The datasourceURI appends relative_uri is the domaindataURI. e.g. the relative_uri is "train/table.csv" the URI of datasource is "/home/data" the URI of domaindata is "/home/data/train/table.csv"
string domain_id = 5
domain_id the unique identity of the domain. the domaindata is belong to this domain.
string datasource_id = 6
datasource_id is the identity of the domaindatasource, the domaindatasource that storage the domaindata file.
map<string, string> attributes = 7
The attributes of the domaindata, this field use as a extra field, User could set this field to any data that they need.
optional partition = 8
Partition not support now,
repeated columns = 9
This field must be set if the type is 'table', The columns describe the table's schema information.
string vendor = 10
The vendor is the one who outputs the domain data, it may be the SecretFlow engine, another vendor's engine, or manually registered. it's could be manual, secretflow or other vendor string.
string status = 11
The status of the domaindata , enum: Available,Unavailable
string author = 12
FileFormat file_format = 13
file-format only takes effect when the data source type is localfs or oss. default value is csv
message
domaindatagrant.proto:62Used in: , ,
optional data = 1
optional status = 2
message
domaindatagrant.proto:80Used in:
string domaindatagrant_id = 1
string author = 2
string domaindata_id = 3
string grant_domain = 4
optional limit = 5
map<string, string> description = 6
string signature = 7
string domain_id = 8
message
domaindatagrant.proto:163Used in:
repeated domaindatagrant_list = 1
message
domaindatagrant.proto:67Used in:
string phase = 1
string message = 2
repeated records = 3
message
domaindata.proto:174Used in: ,
repeated domaindata_list = 1
message
domaindatasource.proto:124Used in: ,
string domain_id = 1
domain identity
string datasource_id = 2
datasource id
string name = 3
datasource name
string type = 4
datasource type, enum [localfs, oss, mysql]
string status = 5
datasource status, enum [Available,Unavailable]
optional info = 6
datasource info, for domain secretBackend which support set interface in clientSDK, you can set info directly when create or update domainDataSource, you can also set an info_key already existed in secretBackend instead. if you set info and info_key simultaneously, only info_key will take effect.
string info_key = 7
datasource info key, for domain secretBackend which nonsupport set interface in clientSDK, use an secret key instead of info when create or update DomainDataSource, the value refers to info_key is a json format string of DataSourceInfo varies by datasource type
bool access_directly = 8
access directly to datasource or proxy_pass to DataProxy, default is false
message
domaindatasource.proto:120Used in: ,
repeated datasource_list = 1
message
domain_route.proto:157Used in:
string source = 1
string destination = 2
message
domain_route.proto:171Used in:
string name = 1
string destination = 2
string source = 3
optional status = 4
message
domain_route.proto:59Used in:
string name = 1
int32 port = 2
string protocol = 3
bool isTLS = 4
string path_prefix = 5
Used in:
ADDED = 0
MODIFIED = 1
DELETED = 2
ERROR = 3
HEARTBEAT = 4
message
domaindatagrant.proto:91Used in: , ,
int64 expiration_time = 1
int32 use_count = 2
string flow_id = 3
repeated string components = 4
string initiator = 5
string input_config = 6
message
health.proto:37Used in:
bool ready = 1
message
job.proto:311Used in:
string port_name = 1
service port name which defined in AppImage container port.
string scope = 2
service scope which defined in AppImage container port.
string endpoint = 3
service access address.
message
job.proto:80Used in:
string cpu = 1
hard ceiling of CPU/virtual cores that the containers of certain party can use
string memory = 2
limited RAMs that the containers of certain party can use
message
job.proto:244(message has no fields)
Unknown = 0
Pending = 1
Running = 2
Succeeded = 3
Failed = 4
the job run failed
AwaitingApproval = 5
await the partner to approval the job
ApprovalReject = 6
partner reject the job
Cancelled = 7
the job cannot start again when it was cancelled
Suspended = 8
the job was suspended
message
job.proto:288Used in: ,
string job_id = 1
optional status = 2
message
job.proto:193Used in: , ,
string state = 1
string err_msg = 2
string create_time = 3
string start_time = 4
string end_time = 5
repeated tasks = 6
repeated stage_status_list = 7
repeated approve_status_list = 8
message
job.proto:278optional status = 1
optional data = 2
message
job.proto:283Used in:
string job_id = 1
optional status = 2
message
domaindatagrant.proto:152Used in:
string domain_id = 1
string grant_domain = 2
string domaindata_vendor = 3
message
domaindata.proto:165Used in:
string domain_id = 1
couldn't be empty
string domaindata_type = 2
Optional, The domaindata_type would be use as the filter condition to list the domaindata.
string domaindata_vendor = 3
Optional, the domaindata_vendor would be use as the filter condition to list the domaindata.
message
domaindatasource.proto:164datasource info for local path
Used in:
string path = 1
the local path of datasource
message
domain_route.proto:74Used in: ,
string tls_ca = 1
string source_client_private_key = 2
string source_client_cert = 3
message
domain.proto:79Used in: ,
string name = 1
string status = 2
string version = 3
string last_heartbeat_time = 4
string last_transition_time = 5
message
domaindatasource.proto:202Used in:
string endpoint = 1
ODPS address such as "https://odps.xxx.cn-xxx.com"
string project = 2
string access_key_id = 3
string access_key_secret = 4
message
domaindatasource.proto:171datasource info for oss oss not support now
Used in:
string endpoint = 1
endpoint https://oss.xxx.cn-xxx.com or http://127.0.0.1:9000
string bucket = 2
the bucket name of the oss datasource
string prefix = 3
the prefix of the oss datasource. e.g. data/traindata/
string access_key_id = 4
access key
string access_key_secret = 5
access secret
bool virtualhost = 6
virtualhost is the same as AliyunOSS's virtualhost , default true
string version = 7
optional enum[s3v2,s3v4]
string storage_type = 8
optional enum[oss,minio] , default oss
message
job.proto:74Used in: ,
string domain_id = 1
string role = 2
server or client
optional resources = 3
resource config for parties
message
job.proto:219Used in:
string domain_id = 1
string state = 2
message
serving.proto:146Used in:
string domain_id = 1
string role = 2
string state = 3
int32 replicas = 4
int32 available_replicas = 5
int32 unavailable_replicas = 6
int32 updatedReplicas = 7
string create_time = 8
repeated endpoints = 9
message
job.proto:214Used in:
string domain_id = 1
string state = 2
message
job.proto:236Used in:
string domain_id = 1
string state = 2
string err_msg = 3
repeated endpoints = 4
repeated ApprovalDetail approval_details= 5;
message
domaindatagrant.proto:121Used in:
string domain_id = 1
string domaindatagrant_id = 2
message
domaindata.proto:140Used in: ,
string domain_id = 1
string domaindata_id = 2
message
domaindatasource.proto:94Used in:
string domain_id = 1
string datasource_id = 2
message
domain.proto:68Used in:
string domain_id = 1
string role = 2
string cert = 3
repeated node_statuses = 4
repeated deploy_token_statuses = 5
map<string, string> annotations = 6
optional auth_center = 7
string master_domain_id = 8
message
domain_route.proto:134Used in:
string name = 1
string authentication_type = 2
string destination = 3
optional endpoint = 4
string source = 5
optional token_config = 6
optional mtls_config = 7
optional status = 8
optional transit = 9
optional body_encryption = 10
message
job.proto:169Used in:
string job_id = 1
string initiator = 2
int32 max_parallelism = 3
repeated tasks = 4
optional status = 5
map<string, string> custom_fields = 6
message
serving.proto:58Used in:
string serving_input_config = 1
string initiator = 2
repeated parties = 3
optional status = 4
message
serving.proto:111Container resource.
Used in:
string container_name = 1
string min_cpu = 2
string max_cpu = 3
string min_memory = 4
string max_memory = 5
message
job.proto:140Used in:
string job_id = 1
message
domain_route.proto:54Used in: ,
string host = 1
repeated ports = 2
message
domain_route.proto:147Used in: ,
string status = 1
Succeeded or Failed
string reason = 2
message
serving.proto:99Used in: , ,
string domain_id = 1
string role = 2
string app_image = 3
optional int32 replicas = 4
The Number of desired instances. Default value: 1.
optional update_strategy = 5
repeated resources = 6
string service_name_prefix = 7
message
serving.proto:158Used in:
string port_name = 1
service port name which defined in AppImage container port.
string scope = 2
service scope which defined in AppImage container port.
string endpoint = 3
service access address.
message
serving.proto:167(message has no fields)
Unknown = 0
Pending = 1
Serving has not been processed yet.
Progressing = 2
Serving is publishing, at least one of the parties is unavailable.
PartialAvailable = 3
Serving publication completed, at least one party's multiple instances are not all available.
Available = 4
Serving publication completed, all app instances from all parties are available.
Failed = 5
Serving publication failed.
message
serving.proto:131Used in:
string serving_id = 1
optional status = 2
message
serving.proto:136Used in: ,
string state = 1
string reason = 2
string message = 3
int32 total_parties = 4
int32 available_parties = 5
string create_time = 6
repeated party_statuses = 7
message
job.proto:110Used in:
string job_id = 1
message
job.proto:125Used in:
string job_id = 1
message
job.proto:64Used in:
string app_image = 1
repeated parties = 2
参与方
string alias = 3
string task_id = 4
repeated string dependencies = 5
dependencies tasks
string task_input_config = 6
task input config
int32 priority = 7
message
job.proto:204Used in:
string app_image = 1
镜像
repeated parties = 2
参与方
string alias = 3
string task_id = 4
repeated string dependencies = 5
dependencies tasks
string task_input_config = 6
task input config
int32 priority = 7
message
job.proto:224Used in:
string task_id = 1
string state = 2
string err_msg = 3
string create_time = 4
string start_time = 5
string end_time = 6
repeated parties = 7
string alias = 8
float progress = 9
message
domain_route.proto:67Used in: ,
string destination_public_key = 1
int64 rolling_update_period = 2
string source_public_key = 3
string token_gen_method = 4
message
domain_route.proto:81Transit defines the information of the transit entity used to forward the request.
Used in: ,
string transit_method = 1
transit_method means to forward the request through a specific entity. Supports the following types: 1. THIRD-DOMAIN: means to forward the request through the third domain 2. REVERSE-TUNNEL: means to forward the request through reverse tunneling between envoys.
optional domain = 2
domain defines the information of the third domain. optional
message
domain_route.proto:82Used in:
string domain_id = 1
message
serving.proto:119Used in:
string type = 1
The Type of serving updating strategy. Can be "Recreate" or "RollingUpdate", default is RollingUpdate.
string max_surge = 2
The maximum number of instances that can be scheduled above the desired number of instances. Default is 25%.
string max_unavailable = 3
The maximum number of instances that can be unavailable during the update. Default is 25%.
message
domaindatagrant.proto:73Used in:
int64 use_time = 1
string grant_domain = 2
string component = 3
string output = 4