CreateSwimLaneGroup - Alibaba Cloud Service Mesh - Alibaba Cloud Documentation Center

Creates a traffic lane group.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

servicemesh:CreateSwimLaneGroup

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ServiceMeshId	string	Yes	The ID of the Service Mesh (ASM) instance.	xxx
ServicesList	string	Yes	The list of services to associate with the traffic lane group. The value must be a JSON array. The format for a single service is `$clusterName/$clusterId/$namespace/$serviceName`.	[\"sh01/c089443ea9e50403fa4f0a6237d11e0a9/default/mocka\",\"sh01/c089443ea9e50403fa4f0a6237d11e0a9/default/mockb\",\"sh01/c089443ea9e50403fa4f0a6237d11e0a9/default/mockc\"]
GroupName	string	Yes	The name of the traffic lane group.	test
IngressType	string	Yes	The ingress traffic type. Currently, only ASM gateways are supported.	ASM
IngressGatewayName	string	Yes	The name of the ASM gateway for traffic routing. A gateway rule with the same name as the ASM gateway is required. For ASM instances of version 1.17.2.28 or later, you can specify the name of a gateway rule, which does not need to have the same name as the ASM gateway.	ingressgateway
IsPermissive	boolean	No	Specifies whether the traffic lane is created in loose mode.	false
TraceHeader	string	No	The request header for trace pass-through for the traffic lane group in loose mode. This parameter is required if you set IsPermissive to true.	my-request-id
RouteHeader	string	No	The request header for routing traffic to the traffic lane group in loose mode. This parameter is required if you set IsPermissive to true.	x-asm-prefer-tag
IngressGatewayNamespace	string	No	The namespace where the gateway rule for routing traffic to the traffic lane group is located. You can specify this parameter for ASM instances of version 1.17.2.28 or later.	istio-system

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	yyyy

Examples

Success response

JSON format

{
  "RequestId": "yyyy"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.