CreateTransitRouterPolicyTable

Updated at:

Creates a policy route table for an Enterprise Edition transit router.

Operation description

  • Only Enterprise Edition transit routers support the creation of policy route tables. For information about the regions and zones supported by Enterprise Edition transit routers, see What is Cloud Enterprise Network?.

  • The CreateTransitRouterPolicyTable operation is asynchronous. After you call this operation, the system returns a policy route table ID, but the policy route table is not yet created and the creation task is still running in the background. You can call the DescribeTransitRouterPolicyTables operation to query the status of the policy route table.

    • If the policy route table is in the Creating state, it indicates that the policy route table is being created. In this state, you can only perform query operations.

    • If the policy route table is in the Active state, it indicates that the policy route table is created.

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

cen:CreateTransitRouterPolicyTable

create

TransitRouterPolicyTable

acs:cen:*:{#accountId}:centransitrouterpolicytable/*

TransitRouter

acs:cen:*:{#accountId}:centransitrouter/{#centransitrouterId}

None None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

ClientToken

string

No

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the value, but you must ensure that it is unique among different requests. The client token can contain only ASCII characters.

Note

If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId of each API request is unique.

02fb3da4-130e-11e9-8e44-001****

TransitRouterId

string

Yes

The ID of the Enterprise Edition transit router.

tr-uf654ttymmljlvh2x****

Name

string

No

The name of the policy route table.

nametest

Description

string

No

The description of the policy route table.

descriptiontest

DryRun

boolean

No

Specifies whether to perform a dry run on the creation request. The dry run includes permission and instance status checks. Valid values:

  • false (default): sends a regular request and performs only a check. If the request passes the check, the policy route table is created.

  • true: sends a dry run request and performs only a check without creating the policy route table. The system checks whether required parameters are specified and validates the request format. If the request fails the check, the corresponding error code is returned. If the request passes the check, the corresponding request ID is returned.

false

Tag

array<object>

No

The tags of the policy route table.

object

No

The tag that is added to the policy route table.

{"Key":"tagtest","Value":"tagtest"}

Key

string

No

The tag key.

tagtest

Value

string

No

The tag value.

tagtest

Response elements

Element

Type

Description

Example

object

Schema of Response

PolicyTableId

string

The ID of the policy route table.

ptbl-44m0p68spvlrqq****

RequestId

string

The request ID.

2BFA6822-240E-4E27-B4C8-AA400EF7474D

Examples

Success response

JSON format

{
  "PolicyTableId": "ptbl-44m0p68spvlrqq****",
  "RequestId": "2BFA6822-240E-4E27-B4C8-AA400EF7474D"
}

Error codes

HTTP status code

Error code

Error message

Description

400 InstanceNotExist.TransitRouter The transitRouter is not exist. The error message returned because the specified transit router does not exist.
400 OperationUnsupported.TransitRouterType The operation is not supported because of the wrong transitRouter type. The error message returned because this operation is not supported by the specified type of transit router.
400 IncorrectStatus.TransitRouter TransitRouter status is invalid. The error message returned because the status of the transit router does not support this operation. Try again later.
400 OperationUnsupported.PolicyBasedRouting PolicyBasedRouting is unsupported. Policy-based routing is not supported.
400 InvalidParameter.TagValue The specified parameter TagValue is invalid. The input parameter Tag Value is invalid.
400 InvalidParameter.TransitRouterId The specified parameter TransitRouterId is invalid. The parameter TransitRouterId entered is illegal.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.