獲取工作流信息。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| edas:ReadSchedulerxWorkflowQuery | get | *全部資源 * |
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 | public |
| Namespace | string | 是 | 命名空間 ID | 4a06d5ea-f576-4326-842c-fb14ea043d8d |
| NamespaceSource | string | 否 | 命名空間來源 | source |
| GroupId | string | 是 | 應(yīng)用分組 ID | hxm.test |
| WorkflowId | long | 是 | 工作流 ID | 1234 |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"RequestId": "45678xxx",
"Code": 200,
"Message": "workflow is not existed",
"Success": true,
"Data": {
"WorkFlowInfo": {
"WorkflowId": 0,
"Name": "workflow_111",
"Description": "my first workflow",
"Status": "成功",
"TimeType": "cron",
"TimeExpression": "0 0 2 * * ?"
},
"WorkFlowNodeInfo": {
"Nodes": [
{
"Id": 0,
"Label": "job_111",
"Status": 1
}
],
"Edges": [
{
"Source": 100,
"Target": 200
}
]
}
},
"AccessDeniedDetail": {
"AuthAction": "",
"AuthPrincipalDisplayName": "",
"AuthPrincipalOwnerId": "",
"AuthPrincipalType": "",
"EncodedDiagnosticMessage": "",
"NoPermissionType": "",
"PolicyType": ""
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-10-18 | OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
| 2022-12-26 | OpenAPI 描述信息更新 | 查看變更詳情 |
| 2021-12-21 | OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
| 2021-12-20 | 新增 OpenAPI | 查看變更詳情 |
示例 Demo
package com.alibaba.schedulerx.pop;
import com.alibaba.schedulerx.common.util.JsonUtil;
import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.exceptions.ClientException;
import com.aliyuncs.exceptions.ServerException;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.schedulerx2.model.v20190430.GetWorkFlowRequest;
import com.aliyuncs.schedulerx2.model.v20190430.GetWorkFlowResponse;
public class TestGetWorkFlow {
public static void main(String[] args) {
// OpenAPI 的接入點(diǎn)，具體請查看支持地域列表或根據(jù)購買地域填寫
String regionId = "public";
//鑒權(quán)使用的 AccessKey ID，由阿里云官網(wǎng)控制臺獲取
String accessKeyId = "xxxxxxx";
//鑒權(quán)使用的 AccessKey Secret，由阿里云官網(wǎng)控制臺獲取
String accessKeySecret = "xxxxxxxxx";
//產(chǎn)品名稱
String productName ="schedulerx2";
//對照支持地域列表選擇 Domain 填寫
String domain ="schedulerx.aliyuncs.com";
//構(gòu)建 OpenAPI 客戶端
DefaultProfile.addEndpoint(regionId, productName, domain);
DefaultProfile defaultProfile = DefaultProfile.getProfile(regionId, accessKeyId, accessKeySecret);
DefaultAcsClient client = new DefaultAcsClient(defaultProfile);
GetWorkFlowRequest request = new GetWorkFlowRequest();
request.setNamespace("433d8b23-06e9-408c-aaaa-90d4d1b9a4af");
request.setGroupId("xuren_test");
request.setWorkflowId(29L);
GetWorkFlowResponse response;
try {
response = client.getAcsResponse(request);
if (!response.getSuccess()) {
System.out.println(JsonUtil.toJson(response));
} else {
System.out.println("工作流基本信息：" + response.getData().getWorkFlowInfo());
System.out.println("工作流節(jié)點(diǎn)信息：" + response.getData().getWorkFlowNodeInfo());
}
} catch (ServerException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (ClientException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}