DesignateWorkers - 指定机器_微服务引擎(MSE)-阿里云帮助中心

指定机器。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
edas:ManageSchedulerxDesignateWorkers	create	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
Namespace	string	是	命名空间 UID	4a06d5ea-f576-4326-842c-fb14ea043d8d
NamespaceSource	string	否	命名空间来源	schedulerx
GroupId	string	是	应用分组 ID	hxm.test
JobId	long	是	任务 ID	144153
Transferable	boolean	是	是否故障转移	true
DesignateType	integer	是	指定机器的类型：1.worker, 2.label	1
Workers	string	否	指定机器列表 JSON 格式列表	["127.0.0.1","127.0.0.2"]
Labels	string	否	指定`label`列表`json`格式列表	["gray"]
RegionId	string	是	地域	public

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID	765xxx
Message	string	错误信息	job is not existed
Code	integer	错误码	200
Success	boolean	是否成功	true

示例

正常返回示例

JSON格式

{
  "RequestId": "765xxx",
  "Message": "job is not existed",
  "Code": 200,
  "Success": true,
  "AccessDeniedDetail": {
    "AuthAction": "",
    "AuthPrincipalDisplayName": "",
    "AuthPrincipalOwnerId": "",
    "AuthPrincipalType": "",
    "EncodedDiagnosticMessage": "",
    "NoPermissionType": "",
    "PolicyType": ""
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-10-21	OpenAPI 返回结构发生变更	查看变更详情
2022-12-26	API 内部配置变更，不影响调用	查看变更详情
2021-12-21	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2021-12-20	新增 OpenAPI	查看变更详情

示例 Demo

package com.alibaba.schedulerx.pop;

import java.util.List;

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.DesignateWorkersRequest;
import com.aliyuncs.schedulerx2.model.v20190430.DesignateWorkersResponse;
import com.google.common.collect.Lists;

public class TestDesignateWorkers {

    public static void main(String[] args) {
     // OpenAPI 的接入点，具体查看支持地域列表或根据购买地域填写
        String regionId = "public";
      //鉴权使用的 AccessKey ID，由阿里云官网控制台获取
        String accessKeyId = "xxxxxxxx";
        //鉴权使用的 AccessKey Secret，由阿里云官网控制台获取
        String accessKeySecret = "xxxxxxxxx";
        //产品名称
        String productName ="schedulerx2";
        //对照支持地域列表选择 Domain 填写
        String domain ="schedulerx.aliyuncs.com";
        //构建 OpenAPI 客户端
        DefaultProfile.addEndpoint(regionId, productName, domain);
        DefaultProfile defaultProfile = DefaultProfile.getProfile(regionId, accessKeyId, accessKeySecret);
        DefaultAcsClient client = new DefaultAcsClient(defaultProfile);
        
        DesignateWorkersRequest request = new DesignateWorkersRequest();
        request.setNamespace("433d8b23-06e9-408c-aaaa-90d4d1b9a4af");
        request.setGroupId("xuren_test");
        request.setJobId(3048L);
        //是否故障转移
        request.setTransferable(true);
        //1 表示指定 worker，2 表示指定 label
        request.setDesignateType(1);
        List<String> workers = Lists.newArrayList();
        workers.add("30.225.16.104");
        //workers 需要 json 格式
        request.setWorkers(JsonUtil.toJson(workers));
        DesignateWorkersResponse response;
        try {
            response = client.getAcsResponse(request);
            System.out.println(JsonUtil.toJson(response));
        } catch (ServerException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        } catch (ClientException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
    }
    
}