DesignateWorkers - SchedulerX - Alibaba Cloud Documentation Center

Designates machines.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
edas:ManageSchedulerxDesignateWorkers	create	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Namespace	string	Yes	The unique identifier (UID) of the namespace.	4a06d5ea-f576-4326-842c-fb14ea043d8d
NamespaceSource	string	No	The source of the namespace.	schedulerx
GroupId	string	Yes	The application group ID.	hxm.test
JobId	long	Yes	The job ID.	144153
Transferable	boolean	Yes	Specifies whether to allow a failover.	true
DesignateType	integer	Yes	The type of the machines to be designated. Valid values: 1 and 2. The value 1 specifies the worker type. The value 2 specifies the label type.	1
Workers	string	No	The designated machines. Specify the value of the parameter in a JSON string.	["127.0.0.1","127.0.0.2"]
Labels	string	No	The designated `labels`. Specify the value of the parameter in a `JSON` string.	["gray"]
RegionId	string	Yes	The region ID.	public

Response parameters

Parameter	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	765xxx
Message	string	The returned error message.	job is not existed
Code	integer	The HTTP status code.	200
Success	boolean	Indicates whether the request was successful.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "765xxx",
  "Message": "job is not existed",
  "Code": 200,
  "Success": true
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-10-21	The response structure of the API has changed	View Change Details
2022-12-26	The internal configuration of the API is changed, but the call is not affected	View Change Details
2021-12-21	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2021-12-20	Add Operation	View Change Details

Sample code

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) {
     // The region ID. Enter a value by referring to the Endpoints topic or based on the region in which you purchased the service.
        String regionId = "public";
      // The AccessKey ID that is used for authentication. You can obtain the AccessKey ID in the RAM console.
        String accessKeyId = "xxxxxxxx";
        // The AccessKey secret that is used for authentication. You can obtain the AccessKey secret in the RAM console.
        String accessKeySecret = "xxxxxxxxx";
        // The name of the service.
        String productName ="schedulerx2";
        // The domain. Enter a domain by referring to the Endpoints topic.
        String domain ="schedulerx.aliyuncs.com";
        // Build an API client.
        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);
        // Specify whether to allow a failover.
        request.setTransferable(true);
        // The type of the designated machines. The value 1 indicates the worker type. The value 2 indicates the label type.
        request.setDesignateType(1);
        List<String> workers = Lists.newArrayList();
        workers.add("30.225.16.104");
        // The designated machines. Specify the value in a JSON string.
        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();
        }
    }
    
}