All Products
Search
Document Center

SchedulerX:CreateRouteStrategy

Last Updated:Dec 10, 2024

Creates a routing policy.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
edas:CreateSchedulerxRouteStrategyCreatecreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
NamestringYes

The name of the routing policy.

test-strategy
GroupIdstringYes

The ID of the application group. You can obtain the ID on the Application Management page in the SchedulerX console.

testSchedulerx.defaultGroup
JobIdlongNo

The job ID. You can obtain the ID on the Task Management page in the SchedulerX console.

54978
TypeintegerNo

The type of the routing policy. Valid value:

  • 3: routes by proportion.
3
StatusintegerNo

Specifies whether to enable the routing policy. Valid values:

  • 0: disables the routing policy.
  • 1: enables the routing policy.
1
StrategyContentstringNo

The details of the routing policy. The value is a JSON string. For more information about this parameter, see the additional information about request parameters below this table.

[{"percentage":20,"target":"[\"version1\"]","targetType":"label"}]
NamespacestringYes

The namespace ID. You can obtain the namespace ID on the Namespace page in the SchedulerX console.

adcfc35d-e2fe-4fe9-bbaa-20e90ffc****

If you set Type to 3, set the parameters that are nested under StrategyContent based on the following requirements:

  • percentage: the percentage of routed traffic. Valid values: 0 to 100. Unit: %.
  • target: routing destinations. If you set targetType to label, set this parameter to label names. If you set targetType to worker, set this parameter to the IP addresses of workers.********
  • targetType: the type of routing destinations. If you set this parameter to label, traffic is routed to workers with the specified labels. If you set this parameter to worker, traffic is routed to workers with the specified IP addresses.

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

4F68ABED-AC31-4412-9297-D9A8F0401108
Codeinteger

The HTTP status code.

200
Messagestring

The additional information, including errors and tips.

strategy name is null or empty.
Successboolean

Indicates whether the call was successful. Valid values:

  • true
  • false
true
Dataobject

The returned data.

Examples

Sample success responses

JSONformat

{
  "RequestId": "4F68ABED-AC31-4412-9297-D9A8F0401108",
  "Code": 200,
  "Message": "strategy name is null or empty.",
  "Success": true,
  "Data": {}
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-10-21The response structure of the API has changedView Change Details
2023-03-30The internal configuration of the API is changed, but the call is not affectedView Change Details