UpdateApplicationVswitches

更新时间:
复制 MD 格式

Updates the vSwitch configuration for an application.

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

sae:UpdateApplicationVswitches

update

*All Resource

*

None None

Request syntax

PUT /pop/v1/sam/app/updateAppVswitches HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

AppId

string

Yes

The application ID.

0099b7be-5f5b-4512-a7fc-56049ef1****

VSwitchId

string

Yes

The vSwitch ID.

vsw-2ze559r1z1bpwqxwp****

Deploy

boolean

No

Indicates whether to deploy the application immediately. Valid values:

  • true: Deploys the application immediately. This is the default.

  • false: The application is not deployed.

true

MinReadyInstances

integer

No

The minimum number of ready instances.

MinReadyInstanceRatio

integer

No

The minimum percentage of ready instances.

Response elements

Element

Type

Description

Example

object

The returned data.

RequestId

string

The request ID.

91F93257-7A4A-4BD3-9A7E-2F6EAE6D****

Message

string

The returned message. Valid values:

  • If the request is successful, success is returned.

  • If the request fails, an error message is returned.

success

TraceId

string

The trace ID. You can use this ID to trace the request.

0a98a02315955564772843261e****

ErrorCode

string

The error code.

  • This parameter is not returned for successful requests.

  • This parameter is returned if the request fails. For more information, see the Error codes section in this topic.

Code

string

The HTTP status code. Valid values:

  • 2xx: The request is successful.

  • 3xx: The request is redirected.

  • 4xx: The request is invalid.

  • 5xx: A server error occurred.

200

Success

boolean

Indicates whether the request was successful. Valid values:

  • true

  • false

true

Examples

Success response

JSON format

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidParameter.NotEmpty You must specify the parameter %s.
400 InvalidApplication.NotFound The current application does not exist.
400 InvalidParameter.WithMessage The parameter is invalid {%s}: %s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.