DocsICP FilingConsole
Documentation

UpdateAndAttachPolicy

Updated at:
Copy as MD
Product
My Favorites

Updates and attaches a policy.

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

apig:UpdateAndAttachPolicy

none

*Policy

acs:apig:{#regionId}:{#accountId}:policy/{#PolicyId}

 None None

Request syntax

PUT /v1/policies/{policyId} HTTP/1.1

Path Parameters

Parameter

Type

Required

Description

Example
policyId

string

Yes

The policy ID.

p-cq7l5s5lhtgi6qasrdc0

Request parameters

Parameter

Type

Required

Description

Example
body

object

No

The request body.

name

string

No

The name of the policy.

test
description

string

No

The description of the policy.

这是策略描述。
config

string

Yes

The policy configuration. The value must be a JSON string.

{\"enable\":false}
attachResourceIds

array

Yes

A list of attachment point IDs.

string

No

The attachment point ID.

api-cq2avtllhtgja4dk5djg

attachResourceType

string

Yes

The type of resource to which the policy is attached. Valid values include:

  • HttpApi: an HTTP API.

  • Operation: an operation of an HTTP API.

  • GatewayRoute: a gateway route.

  • GatewayService: a gateway service.

  • GatewayServicePort: a port of a gateway service.

  • Domain: a gateway domain.

  • Gateway: a gateway.

HttpApi
environmentId

string

No

The environment ID.

env-cq2avtllhtgja4dk5djg

gatewayId

string

No

The gateway ID.

gw-cq2avtllhtgja4dk5djg

Response elements

Element

Type

Description

Example

object

The response data.

requestId

string

The ID of the request, used to trace the API call.

585657D2-1C20-5B8A-AF17-D727C6490BE4
code

string

The response code.

Ok
message

string

The response message.

success

Examples

Success response

JSON format

{
  "requestId": "585657D2-1C20-5B8A-AF17-D727C6490BE4",
  "code": "Ok",
  "message": "success"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.