Merge pull request #9726 from learnerjohn/feat/api-gateway-existing-fixes

resource/alicloud_api_gateway_api: Fix backend_id read issue; resource/alicloud_api_gateway_vpc_access: Add vpc_access_id

Author: xuzhang3

alicloud/resource_alicloud_api_gateway_api.go

@@ -352,6 +352,14 @@ func resourceAliyunApigatewayApi() *schema.Resource {
 				Optional: true,
 				Computed: true,
 			},
+			"backend_id": {
+				Type:     schema.TypeString,
+				Optional: true,
+			},
+			"backend_enabled": {
+				Type:     schema.TypeBool,
+				Optional: true,
+			},
 		},
 	}
 }
@@ -456,6 +464,15 @@ func resourceAliyunApigatewayApiRead(d *schema.ResourceData, meta interface{}) e
 
 	d.Set("system_parameters", convertApiGatewayApiSystemParamsResponse(objectRaw["SystemParameters"]))
 
+	if backendConfig, ok := objectRaw["BackendConfig"].(map[string]interface{}); ok {
+		if v, ok := backendConfig["BackendId"].(string); ok && v != "" {
+			d.Set("backend_id", v)
+		}
+	}
+	if v, ok := objectRaw["BackendEnable"]; ok {
+		d.Set("backend_enabled", v)
+	}
+
 	return nil
 }
 
@@ -497,7 +514,7 @@ func resourceAliyunApigatewayApiUpdate(d *schema.ResourceData, meta interface{})
 	}
 	request.RequestConfig = paramConfig
 
-	if d.HasChanges("service_type", "http_service_config", "http_vpc_service_config", "mock_service_config", "fc_service_config") {
+	if d.HasChanges("service_type", "http_service_config", "http_vpc_service_config", "mock_service_config", "fc_service_config", "backend_id", "backend_enabled") {
 		update = true
 	}
 	serviceConfig, err := serviceConfigToJsonStr(d)
@@ -524,6 +541,14 @@ func resourceAliyunApigatewayApiUpdate(d *schema.ResourceData, meta interface{})
 		request.AllowSignatureMethod = AllowSignatureMethod
 		request.WebSocketApiType = WebSocketApiType
 
+		backendEnabled := d.Get("backend_enabled").(bool)
+		request.QueryParams["BackendEnable"] = strconv.FormatBool(backendEnabled)
+		if backendEnabled {
+			if v, ok := d.GetOk("backend_id"); ok && v.(string) != "" {
+				request.QueryParams["BackendId"] = v.(string)
+			}
+		}
+
 		raw, err := client.WithCloudApiClient(func(cloudApiClient *cloudapi.Client) (interface{}, error) {
 			return cloudApiClient.ModifyApi(request)
 		})
@@ -646,6 +671,14 @@ func buildAliyunApiArgs(d *schema.ResourceData, meta interface{}) (*cloudapi.Cre
 	request.AllowSignatureMethod = AllowSignatureMethod
 	request.WebSocketApiType = WebSocketApiType
 
+	backendEnabled := d.Get("backend_enabled").(bool)
+	request.QueryParams["BackendEnable"] = strconv.FormatBool(backendEnabled)
+	if backendEnabled {
+		if v, ok := d.GetOk("backend_id"); ok && v.(string) != "" {
+			request.QueryParams["BackendId"] = v.(string)
+		}
+	}
+
 	return request, WrapError(err)
 }
 

alicloud/resource_alicloud_api_gateway_api_test.go

@@ -1371,6 +1371,32 @@ func resourceApigatewayApiConfigDependence_vpc(name string) string {
 	`, name, ApigatewayVpcAccessConfigDependence)
 }
 
+func resourceapigatewayapiconfigdependenceBackend(name string) string {
+	return fmt.Sprintf(`
+
+	variable "name" {
+	  default = "%s"
+	}
+
+	resource "alicloud_api_gateway_group" "default" {
+	  name = "${var.name}"
+	  description = "tf_testAcc_api group description"
+	}
+
+	resource "alicloud_api_gateway_backend" "default" {
+	  backend_name = "${var.name}_backend"
+	  backend_type = "HTTP"
+	  description  = var.name
+	}
+
+	resource "alicloud_api_gateway_backend" "update" {
+	  backend_name = "${var.name}_backend_update"
+	  backend_type = "HTTP"
+	  description  = var.name
+	}
+	`, name)
+}
+
 var apiGatewayApiMap = map[string]string{
 	"name":                      CHECKSET,
 	"group_id":                  CHECKSET,
@@ -1383,3 +1409,95 @@ var apiGatewayApiMap = map[string]string{
 	"service_type":              CHECKSET,
 	"api_id":                    CHECKSET,
 }
+
+func TestAccAliCloudApigatewayApi_backend(t *testing.T) {
+	var api *cloudapi.DescribeApiResponse
+	resourceId := "alicloud_api_gateway_api.default"
+	ra := resourceAttrInit(resourceId, apiGatewayApiMap)
+	serviceFunc := func() interface{} {
+		return &CloudApiService{testAccProvider.Meta().(*connectivity.AliyunClient)}
+	}
+	rc := resourceCheckInit(resourceId, &api, serviceFunc)
+	rac := resourceAttrCheckInit(rc, ra)
+	testAccCheck := rac.resourceAttrMapUpdateSet()
+	rand := acctest.RandIntRange(1000000, 9999999)
+	name := fmt.Sprintf("tf_testAccApiGatewayApi_%d", rand)
+	testAccConfig := resourceTestAccConfigFunc(resourceId, name, resourceapigatewayapiconfigdependenceBackend)
+
+	resource.Test(t, resource.TestCase{
+		PreCheck: func() {
+			testAccPreCheck(t)
+		},
+		IDRefreshName: resourceId,
+		Providers:     testAccProviders,
+		CheckDestroy:  rac.checkResourceDestroy(),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccConfig(map[string]interface{}{
+					"name":        "${alicloud_api_gateway_group.default.name}",
+					"group_id":    "${alicloud_api_gateway_group.default.id}",
+					"description": "tf_testAcc_api backend_id",
+					"auth_type":   "ANONYMOUS",
+					"request_config": []map[string]string{{
+						"protocol": "HTTP",
+						"method":   "GET",
+						"path":     "/test/path",
+						"mode":     "MAPPING",
+					}},
+					"service_type": "HTTP",
+					"http_service_config": []map[string]string{{
+						"address": "",
+						"method":  "GET",
+						"path":    "/web/cloudapi",
+						"timeout": "20",
+					}},
+					"backend_id":     "${alicloud_api_gateway_backend.default.id}",
+					"backend_enabled": "true",
+				}),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheck(map[string]string{
+						"name":           name,
+						"description":    "tf_testAcc_api backend_id",
+						"auth_type":      "ANONYMOUS",
+						"service_type":   "HTTP",
+						"backend_id":     CHECKSET,
+						"backend_enabled": "true",
+					}),
+				),
+			},
+			{
+				Config: testAccConfig(map[string]interface{}{
+					"backend_id": "${alicloud_api_gateway_backend.update.id}",
+				}),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheck(map[string]string{
+						"backend_id": CHECKSET,
+					}),
+				),
+			},
+			{
+				ResourceName:            resourceId,
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{},
+			},
+			{
+				Config: testAccConfig(map[string]interface{}{
+					"backend_enabled": "false",
+					"http_service_config": []map[string]string{{
+						"address": "http://apigateway-backend.alicloudapi.com",
+						"method":  "GET",
+						"path":    "/web/cloudapi",
+						"timeout": "20",
+					}},
+				}),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheck(map[string]string{
+						"backend_enabled":               "false",
+						"http_service_config.0.address": "http://apigateway-backend.alicloudapi.com",
+					}),
+				),
+			},
+		},
+	})
+}

alicloud/resource_alicloud_api_gateway_vpc_access.go

@@ -40,6 +40,10 @@ func resourceAliCloudApiGatewayVpcAccess() *schema.Resource {
 				Required: true,
 				ForceNew: true,
 			},
+			"vpc_access_id": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
 		},
 	}
 }
@@ -97,6 +101,9 @@ func resourceAliCloudApiGatewayVpcAccessRead(d *schema.ResourceData, meta interf
 	d.Set("vpc_id", object["VpcId"])
 	d.Set("instance_id", object["InstanceId"])
 	d.Set("port", object["Port"])
+	if v, ok := object["VpcAccessId"]; ok {
+		d.Set("vpc_access_id", v)
+	}
 
 	return nil
 }

website/docs/r/api_gateway_api.html.markdown

@@ -79,6 +79,49 @@ resource "alicloud_api_gateway_api" "example" {
 
 ```
 
+Backend Usage
+
+```terraform
+resource "alicloud_api_gateway_group" "example" {
+  name        = "tf-example"
+  description = "tf-example"
+  base_path   = "/"
+}
+
+resource "alicloud_api_gateway_backend" "example" {
+  backend_name = "tf-example-backend"
+  backend_type = "HTTP"
+  description  = "tf-example"
+}
+
+resource "alicloud_api_gateway_api" "example" {
+  group_id          = alicloud_api_gateway_group.example.id
+  name              = "tf-example"
+  description       = "tf-example"
+  auth_type         = "APP"
+  force_nonce_check = false
+
+  request_config {
+    protocol = "HTTP"
+    method   = "GET"
+    path     = "/example/path"
+    mode     = "MAPPING"
+  }
+
+  service_type = "HTTP"
+
+  http_service_config {
+    address = ""
+    method  = "GET"
+    path    = "/web/cloudapi"
+    timeout = 12
+  }
+
+  backend_id      = alicloud_api_gateway_backend.example.id
+  backend_enabled = true
+}
+```
+
 📚 Need more examples? [VIEW MORE EXAMPLES](https://api.aliyun.com/terraform?activeTab=sample&source=Sample&sourcePath=OfficialSample:alicloud_api_gateway_api&spm=docs.r.api_gateway_api.example&intl_lang=EN_US)
 
 ## Argument Reference
@@ -100,6 +143,8 @@ The following arguments are supported:
 * `system_parameters` - (Optional, List) system_parameters defines the system parameters of the api. See [`system_parameters`](#system_parameters) below.
 * `stage_names` - (Optional, Type: list) Stages that the api need to be deployed. Valid value: `RELEASE`,`PRE`,`TEST`.
 * `force_nonce_check` - (Optional, Type: bool, Available in v1.140+) Whether to prevent API replay attack. Default value: `false`.
+* `backend_id` - (Optional, Available since v1.279.0) The ID of the API Gateway Backend. When specified, the API references an existing backend created by `alicloud_api_gateway_backend`.
+* `backend_enabled` - (Optional, Available since v1.279.0) Specifies whether to enable the backend service. When set to `true`, the `backend_id` will be sent to the API.
 
 ### `request_config`
 

website/docs/r/api_gateway_vpc_access.html.markdown

@@ -107,6 +107,7 @@ The following arguments are supported:
 The following attributes are exported:
 
 * `id` - The resource ID in terraform of Vpc Access. It formats as `<name>:<vpc_id>:<instance_id>:<port>`.
+* `vpc_access_id` - The ID of the Vpc Access.
 
 ## Import