All Products
Search

This Product

    Web Application Firewall:ModifyCloudResource

    Document Center

    Web Application Firewall:ModifyCloudResource

    Last Updated:Nov 15, 2024

    Modifies the configurations of a service that is added to Web Application Firewall (WAF).

    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:
      • The required resource types are displayed in bold characters.
      • 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
    yundun-waf:ModifyCloudResourceupdate
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InstanceIdstringYes

    The ID of the WAF instance.

    Note You can call the DescribeInstance operation to query the ID of the WAF instance.
    		waf_v3prepaid_public_cn-***
    ResourceManagerResourceGroupIdstringNo

    The ID of the Alibaba Cloud resource group.

    		rg-acfm***q
    ListenobjectYes

    The configurations of the listeners.

    TLSVersionstringNo

    The Transport Layer Security (TLS) version. This parameter is available only if you specify HttpsPorts. Valid values:

    • tlsv1
    • tlsv1.1
    • tlsv1.2
    		tlsv1.2
    EnableTLSv3booleanNo

    Specifies whether to support TLS 1.3. This parameter is available only if you specify HttpsPorts. Valid values:

    • true
    • false
    		true
    CipherSuiteintegerNo

    The type of the cipher suites that you want to add. This parameter is available only if you specify HttpsPorts. Valid values:

    • 1: all cipher suites.
    • 2: strong cipher suites. You can set the parameter to this value only if you set TLSVersion to tlsv1.2.
    • 99: custom cipher suites.
    		1
    CustomCiphersarrayNo

    An array of custom cipher suites.

    stringNo

    The custom cipher suites that you want to add. This parameter is available only if you set CipherSuite to 99.

    		ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:AES128-GCM-SHA256:AES256-GCM-SHA384
    ResourceProductstringYes

    The cloud service. Valid values:

    • clb4: Layer 4 Classic Load Balancer (CLB).
    • clb7: Layer 7 CLB.
    • ecs: Elastic Compute Service (ECS).
    		clb7
    ResourceInstanceIdstringYes

    The ID of the resource.

    		lb-***
    PortintegerYes

    The port of the resource that you want to add to WAF.

    		80
    ProtocolstringYes

    The type of the protocol. Valid values:

    • http
    • https
    		http
    Certificatesarray<object>No

    An array of certificates.

    objectNo

    The certificate information.

    CertificateIdstringNo

    The ID of the certificate.

    		123-cn-hangzhou
    AppliedTypestringNo

    The type of the HTTPS certificate. Valid values:

    • default: default certificate.
    • extension: additional certificate.
    		default
    Http2EnabledbooleanNo

    Specifies whether to enable HTTP/2. This parameter is available only if you specify HttpsPorts. Valid values:

    • true
    • false (default)
    		true
    RedirectobjectNo

    The configurations of the forwarding rule.

    RequestHeadersarray<object>No

    The custom header field that you want to use to label requests that are processed by WAF.

    objectNo

    Specify the value in the [{"k":"key","v":"value"}] format. key specifies the key of the custom header field. value specifies the value of the custom header field.

    Note If the request contains the custom header field, WAF overwrites the original value of the field with the specified value.
    KeystringNo

    The key of the custom header field.

    		key1
    ValuestringNo

    The value of the custom header field.

    		value1
    XffHeaderModeintegerNo

    The method that WAF uses to obtain the originating IP address of a client. Valid values:

    • 0: No Layer 7 proxies are deployed in front of WAF.
    • 1: WAF reads the first value of the X-Forwarded-For (XFF) header field as the originating IP address of the client.
    • 2: WAF reads the value of a custom header field as the originating IP address of the client.
    		0
    XffHeadersarrayNo

    The custom header field that is used to obtain the originating IP address of a client. Specify the value in the ["header1","header2",...] format.

    Note This parameter is required only if you set XffHeaderMode to 2.
    stringNo

    The custom header field that is used to obtain the originating IP address of a client. Specify the value in the ["header1","header2",...] format.

    Note This parameter is required only if you set XffHeaderMode to 2.
    		header1
    ReadTimeoutintegerNo

    The timeout period for read connections. Unit: seconds. Valid values: 1 to 3600.

    		1
    WriteTimeoutintegerNo

    The timeout period for write connections. Unit: seconds. Valid values: 1 to 3600.

    		1
    KeepalivebooleanNo

    Specifies whether to enable the persistent connection feature. Valid values:

    • true (default)
    • false:
    		true
    KeepaliveRequestsintegerNo

    The number of requests that reuse persistent connections. Valid values: 60 to 1000.

    Note This parameter specifies the number of requests that can reuse persistent connections after you enable the persistent connection feature.
    		1000
    KeepaliveTimeoutintegerNo

    The timeout period for idle persistent connections. Valid values: 10 to 3600. Default value: 3600. Unit: seconds.

    Note If no new requests are initiated over the idle persistent connection within the specified timeout period, the connection is closed.
    		15
    XffProtobooleanNo

    Specifies whether to use the X-Forward-For-Proto header to identify the protocol used by WAF to forward requests to the origin server. Valid values:

    • true (default)
    • false
    		true
    RegionIdstringYes

    The region in which the WAF instance is deployed. Valid values:

    • cn-hangzhou: the Chinese mainland.
    • ap-southeast-1: outside the Chinese mainland.
    		cn-hangzhou

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		D7861F61-5B61-46CE-A47C-***
    CloudResourcestring

    The ID of the resource that is added to WAF.

    		lb-xxx-80-clb7

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "D7861F61-5B61-46CE-A47C-***",
  "CloudResource": "lb-xxx-80-clb7"
}

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    2024-10-10The internal configuration of the API is changed, but the call is not affectedView Change Details