All Products
Search
Document Center

API Gateway:UpdateAndAttachPolicy

Last Updated:Dec 17, 2025

Updates and associates a 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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
apig:UpdateAndAttachPolicynone
*Policy
acs:apig:{#regionId}:{#accountId}:policy/{#PolicyId}
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
policyIdstringYes

The policy ID.

p-cq7l5s5lhtgi6qasrdc0
bodyobjectNo

The request body.

namestringNo

The policy name.

test
descriptionstringNo

The policy description.

This is the description.
configstringYes

The policy configurations. The value is a JSON string.

{\"enable\":false}
attachResourceIdsarrayYes

The association IDs.

stringNo

The association ID.

api-cq2avtllhtgja4dk5djg
attachResourceTypestringYes

The supported associated resource type. Valid values:

  • HttpApi: an HTTP API
  • Operation: an operation in an HTTP API
  • GatewayRoute: a route
  • GatewayService: a service
  • GatewayServicePort: a service port
  • Domain: a domain name
  • Gateway: an instance
HttpApi
environmentIdstringNo

The environment ID.

env-cq2avtllhtgja4dk5djg
gatewayIdstringNo

The instance ID.

gw-cq2avtllhtgja4dk5djg

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

requestIdstring

The request ID, which is used to trace the call link.

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

The status code returned.

Ok
messagestring

The response message returned.

success

Examples

Sample success responses

JSONformat

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

Error codes

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