# 查看作业的上下游依赖关系 - ShowFactoryJobDependInstances #### 功能介绍 提供对外接口，查看作业的上下游依赖关系及责任人。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dataartsstudio/making_request.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dataartsstudio/abcd.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v2/{project_id}/factory/jobs/{job_name}/depend 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参见[项目ID和账号ID](https://support.huaweicloud.com/api-dataartsstudio/projectid_accountid.html)。 | | job_name | 是 | String | 作业名称。指定要查询上下游依赖关系的目标作业名称。 作业名称在创建作业时由用户指定，可通过"查询作业列表"接口获取。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | relation | 否 | String | 查询的依赖方向。用于指定查询作业的直接上游、直接下游或同时查询上下游关系。 取值范围： - parent：查询直接上游作业，即当前作业依赖的作业。 - child：查询直接下游作业，即依赖当前作业的作业。 - both：同时查询直接上游和直接下游作业。 默认取值：both | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | workspace | 是 | String | 工作空间ID，获取方法请参见[实例ID和工作空间ID](https://support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0350.html)。 | | X-Auth-Token | 否 | String | IAM Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值），使用Token认证时必选，最小长度：0，最大长度：4096。 | | X-Project-Id | 否 | String | project_id，项目编号。获取方法请参见[项目ID和账号ID](https://support.huaweicloud.com/api-dataartsstudio/projectid_accountid.html)。 多project场景采用AK/SK认证的接口请求，则该字段必选。 | | Content-Type | 是 | String | 默认值：application/json;charset=UTF-8 可选，有Body体的情况下必选，没有Body体则无需填写和校验。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | job_name | String | 依赖的作业名称。 | | job_path | String | 依赖的作业所在目录路径。作业在根目录下返回"/"。 | | depend_layer | String | 当前作业与查询目标作业的依赖关系方向。 取值范围： - parent：当前作业是查询目标作业的上游作业。 - child：当前作业是查询目标作业的下游作业。 | | workspace_name | String | 依赖的作业所在的工作空间名称。 | | owner | String | 作业责任人。创建作业时指定的作业负责人。 | **状态码：400** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | #### 请求示例 查询作业"job_1"的直接上下游依赖关系及责任人。 ``` /v2/{project_id}/factory/jobs/job_1/depend?relation=both [ { "depend_layer" : "child", "job_name" : "job_1", "job_path" : "/depend", "workspace_name" : "default", "owner" : "zhangsan" }, { "depend_layer" : "child", "job_name" : "job_4", "job_path" : "/depend", "workspace_name" : "default", "owner" : "lisi" }, { "depend_layer" : "parent", "job_name" : "job_3", "job_path" : "/depend", "workspace_name" : "default", "owner" : "wangwu" }, { "depend_layer" : "parent", "job_name" : "job_5", "job_path" : "/depend", "workspace_name" : "default", "owner" : "zhaoliu" }, { "depend_layer" : "parent", "job_name" : "job_root_pan", "job_path" : "/", "workspace_name" : "default", "owner" : "tianqi" } ] ``` #### 响应示例 **状态码：200** 成功查询作业的上下游依赖关系。 ``` [ { "depend_layer" : "child", "job_name" : "job_1", "job_path" : "/depend", "workspace_name" : "default", "owner" : "zhangsan" }, { "depend_layer" : "child", "job_name" : "job_4", "job_path" : "/depend", "workspace_name" : "default", "owner" : "lisi" }, { "depend_layer" : "parent", "job_name" : "job_3", "job_path" : "/depend", "workspace_name" : "default", "owner" : "wangwu" }, { "depend_layer" : "parent", "job_name" : "job_5", "job_path" : "/depend", "workspace_name" : "default", "owner" : "zhaoliu" }, { "depend_layer" : "parent", "job_name" : "job_root_pan", "job_path" : "/", "workspace_name" : "default", "owner" : "tianqi" } ] ``` **状态码：400** 失败，返回的错误信息。 ``` { "error_code" : "DLF.5504", "error_msg" : "The relation value [invalid] is illegal and currently only supports parent, child, and both." } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 查询作业"job_1"的直接上下游依赖关系及责任人。 ``` 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.dataartsstudio.v1.region.DataArtsStudioRegion; import com.huaweicloud.sdk.dataartsstudio.v1.*; import com.huaweicloud.sdk.dataartsstudio.v1.model.*; public class ShowFactoryJobDependInstancesSolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DataArtsStudioClient client = DataArtsStudioClient.newBuilder() .withCredential(auth) .withRegion(DataArtsStudioRegion.valueOf("")) .build(); ShowFactoryJobDependInstancesRequest request = new ShowFactoryJobDependInstancesRequest(); request.withJobName("{job_name}"); try { ShowFactoryJobDependInstancesResponse response = client.showFactoryJobDependInstances(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()); } } } ``` - [Python] 查询作业"job_1"的直接上下游依赖关系及责任人。 ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdataartsstudio.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"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DataArtsStudioClient.new_builder() \ .with_credentials(credentials) \ .with_region(DataArtsStudioRegion.value_of("")) \ .build() try: request = ShowFactoryJobDependInstancesRequest() request.job_name = "{job_name}" response = client.show_factory_job_depend_instances(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] 查询作业"job_1"的直接上下游依赖关系及责任人。 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/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") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dataartsstudio.DataArtsStudioClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dataartsstudio.NewDataArtsStudioClient(hcClient) request := &model.ShowFactoryJobDependInstancesRequest{} request.JobName = "{job_name}" response, err := client.ShowFactoryJobDependInstances(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DataArtsStudio/sdk?api=ShowFactoryJobDependInstances)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 成功查询作业的上下游依赖关系。 | | 400 | 失败，返回的错误信息。 |