Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Opentelekomcloud Provider
  3. API Docs
  4. ApigwResponseV2
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud
opentelekomcloud/terraform-provider-opentelekomcloud

opentelekomcloud.ApigwResponseV2

Explore with Pulumi AI

opentelekomcloud logo
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud
opentelekomcloud/terraform-provider-opentelekomcloud

    Up-to-date reference of API arguments for API Gateway group service you can get at documentation portal

    Manages an APIGW (API) custom response resource within OpenTelekomCloud.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as opentelekomcloud from "@pulumi/opentelekomcloud";

const config = new pulumi.Config();
const gatewayId = config.requireObject("gatewayId");
const groupId = config.requireObject("groupId");
const responseName = config.requireObject("responseName");
const test = new opentelekomcloud.ApigwResponseV2("test", {
    gatewayId: gatewayId,
    groupId: groupId,
    rules: [{
        errorType: "AUTHORIZER_FAILURE",
        body: "{\"code\":\"$context.authorizer.frontend.code\",\"message\":\"$context.authorizer.frontend.message\"}",
        statusCode: 401,
    }],
});

    import pulumi
import pulumi_opentelekomcloud as opentelekomcloud

config = pulumi.Config()
gateway_id = config.require_object("gatewayId")
group_id = config.require_object("groupId")
response_name = config.require_object("responseName")
test = opentelekomcloud.ApigwResponseV2("test",
    gateway_id=gateway_id,
    group_id=group_id,
    rules=[{
        "error_type": "AUTHORIZER_FAILURE",
        "body": "{\"code\":\"$context.authorizer.frontend.code\",\"message\":\"$context.authorizer.frontend.message\"}",
        "status_code": 401,
    }])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/opentelekomcloud/opentelekomcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		gatewayId := cfg.RequireObject("gatewayId")
		groupId := cfg.RequireObject("groupId")
		responseName := cfg.RequireObject("responseName")
		_, err := opentelekomcloud.NewApigwResponseV2(ctx, "test", &opentelekomcloud.ApigwResponseV2Args{
			GatewayId: pulumi.Any(gatewayId),
			GroupId:   pulumi.Any(groupId),
			Rules: opentelekomcloud.ApigwResponseV2RuleArray{
				&opentelekomcloud.ApigwResponseV2RuleArgs{
					ErrorType:  pulumi.String("AUTHORIZER_FAILURE"),
					Body:       pulumi.String("{\"code\":\"$context.authorizer.frontend.code\",\"message\":\"$context.authorizer.frontend.message\"}"),
					StatusCode: pulumi.Float64(401),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Opentelekomcloud = Pulumi.Opentelekomcloud;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var gatewayId = config.RequireObject<dynamic>("gatewayId");
    var groupId = config.RequireObject<dynamic>("groupId");
    var responseName = config.RequireObject<dynamic>("responseName");
    var test = new Opentelekomcloud.ApigwResponseV2("test", new()
    {
        GatewayId = gatewayId,
        GroupId = groupId,
        Rules = new[]
        {
            new Opentelekomcloud.Inputs.ApigwResponseV2RuleArgs
            {
                ErrorType = "AUTHORIZER_FAILURE",
                Body = "{\"code\":\"$context.authorizer.frontend.code\",\"message\":\"$context.authorizer.frontend.message\"}",
                StatusCode = 401,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opentelekomcloud.ApigwResponseV2;
import com.pulumi.opentelekomcloud.ApigwResponseV2Args;
import com.pulumi.opentelekomcloud.inputs.ApigwResponseV2RuleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var config = ctx.config();
        final var gatewayId = config.get("gatewayId");
        final var groupId = config.get("groupId");
        final var responseName = config.get("responseName");
        var test = new ApigwResponseV2("test", ApigwResponseV2Args.builder()
            .gatewayId(gatewayId)
            .groupId(groupId)
            .rules(ApigwResponseV2RuleArgs.builder()
                .errorType("AUTHORIZER_FAILURE")
                .body("{\"code\":\"$context.authorizer.frontend.code\",\"message\":\"$context.authorizer.frontend.message\"}")
                .statusCode(401)
                .build())
            .build());

    }
}

    configuration:
  gatewayId:
    type: dynamic
  groupId:
    type: dynamic
  responseName:
    type: dynamic
resources:
  test:
    type: opentelekomcloud:ApigwResponseV2
    properties:
      gatewayId: ${gatewayId}
      groupId: ${groupId}
      rules:
        - errorType: AUTHORIZER_FAILURE
          body: '{"code":"$context.authorizer.frontend.code","message":"$context.authorizer.frontend.message"}'
          statusCode: 401

    Create ApigwResponseV2 Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ApigwResponseV2(name: string, args: ApigwResponseV2Args, opts?: CustomResourceOptions);
    @overload
def ApigwResponseV2(resource_name: str,
                    args: ApigwResponseV2Args,
                    opts: Optional[ResourceOptions] = None)

@overload
def ApigwResponseV2(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    gateway_id: Optional[str] = None,
                    group_id: Optional[str] = None,
                    apigw_response_v2_id: Optional[str] = None,
                    name: Optional[str] = None,
                    rules: Optional[Sequence[ApigwResponseV2RuleArgs]] = None)
    func NewApigwResponseV2(ctx *Context, name string, args ApigwResponseV2Args, opts ...ResourceOption) (*ApigwResponseV2, error)
    public ApigwResponseV2(string name, ApigwResponseV2Args args, CustomResourceOptions? opts = null)
    public ApigwResponseV2(String name, ApigwResponseV2Args args)
public ApigwResponseV2(String name, ApigwResponseV2Args args, CustomResourceOptions options)

    type: opentelekomcloud:ApigwResponseV2
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ApigwResponseV2Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ApigwResponseV2Args
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ApigwResponseV2Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApigwResponseV2Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApigwResponseV2Args
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var apigwResponseV2Resource = new Opentelekomcloud.ApigwResponseV2("apigwResponseV2Resource", new()
{
    GatewayId = "string",
    GroupId = "string",
    ApigwResponseV2Id = "string",
    Name = "string",
    Rules = new[]
    {
        new Opentelekomcloud.Inputs.ApigwResponseV2RuleArgs
        {
            Body = "string",
            ErrorType = "string",
            StatusCode = 0,
        },
    },
});

    example, err := opentelekomcloud.NewApigwResponseV2(ctx, "apigwResponseV2Resource", &opentelekomcloud.ApigwResponseV2Args{
	GatewayId:         pulumi.String("string"),
	GroupId:           pulumi.String("string"),
	ApigwResponseV2Id: pulumi.String("string"),
	Name:              pulumi.String("string"),
	Rules: opentelekomcloud.ApigwResponseV2RuleArray{
		&opentelekomcloud.ApigwResponseV2RuleArgs{
			Body:       pulumi.String("string"),
			ErrorType:  pulumi.String("string"),
			StatusCode: pulumi.Float64(0),
		},
	},
})

    var apigwResponseV2Resource = new ApigwResponseV2("apigwResponseV2Resource", ApigwResponseV2Args.builder()
    .gatewayId("string")
    .groupId("string")
    .apigwResponseV2Id("string")
    .name("string")
    .rules(ApigwResponseV2RuleArgs.builder()
        .body("string")
        .errorType("string")
        .statusCode(0)
        .build())
    .build());

    apigw_response_v2_resource = opentelekomcloud.ApigwResponseV2("apigwResponseV2Resource",
    gateway_id="string",
    group_id="string",
    apigw_response_v2_id="string",
    name="string",
    rules=[{
        "body": "string",
        "error_type": "string",
        "status_code": 0,
    }])

    const apigwResponseV2Resource = new opentelekomcloud.ApigwResponseV2("apigwResponseV2Resource", {
    gatewayId: "string",
    groupId: "string",
    apigwResponseV2Id: "string",
    name: "string",
    rules: [{
        body: "string",
        errorType: "string",
        statusCode: 0,
    }],
});

    type: opentelekomcloud:ApigwResponseV2
properties:
    apigwResponseV2Id: string
    gatewayId: string
    groupId: string
    name: string
    rules:
        - body: string
          errorType: string
          statusCode: 0

    ApigwResponseV2 Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ApigwResponseV2 resource accepts the following input properties:

    GatewayId string
    Specifies the ID of the dedicated instance to which the API group and the API custom response belong. Changing this will create a new resource.
    GroupId string
    Specifies the ID of the API group to which the API custom response belongs. Changing this will create a new resource.
    ApigwResponseV2Id string
    ID of the API custom response.
    Name string
    Specifies the name of the API custom response. The valid length is limited from 1 to 64, letters, digits, hyphens (-) and underscores (_) are allowed.
    Rules List<ApigwResponseV2Rule>

    Specifies the API custom response rules definition. The object structure is documented below.

    The rule block supports:

    GatewayId string
    Specifies the ID of the dedicated instance to which the API group and the API custom response belong. Changing this will create a new resource.
    GroupId string
    Specifies the ID of the API group to which the API custom response belongs. Changing this will create a new resource.
    ApigwResponseV2Id string
    ID of the API custom response.
    Name string
    Specifies the name of the API custom response. The valid length is limited from 1 to 64, letters, digits, hyphens (-) and underscores (_) are allowed.
    Rules []ApigwResponseV2RuleArgs

    Specifies the API custom response rules definition. The object structure is documented below.

    The rule block supports:

    gatewayId String
    Specifies the ID of the dedicated instance to which the API group and the API custom response belong. Changing this will create a new resource.
    groupId String
    Specifies the ID of the API group to which the API custom response belongs. Changing this will create a new resource.
    apigwResponseV2Id String
    ID of the API custom response.
    name String
    Specifies the name of the API custom response. The valid length is limited from 1 to 64, letters, digits, hyphens (-) and underscores (_) are allowed.
    rules List<ApigwResponseV2Rule>

    Specifies the API custom response rules definition. The object structure is documented below.

    The rule block supports:

    gatewayId string
    Specifies the ID of the dedicated instance to which the API group and the API custom response belong. Changing this will create a new resource.
    groupId string
    Specifies the ID of the API group to which the API custom response belongs. Changing this will create a new resource.
    apigwResponseV2Id string
    ID of the API custom response.
    name string
    Specifies the name of the API custom response. The valid length is limited from 1 to 64, letters, digits, hyphens (-) and underscores (_) are allowed.
    rules ApigwResponseV2Rule[]

    Specifies the API custom response rules definition. The object structure is documented below.

    The rule block supports:

    gateway_id str
    Specifies the ID of the dedicated instance to which the API group and the API custom response belong. Changing this will create a new resource.
    group_id str
    Specifies the ID of the API group to which the API custom response belongs. Changing this will create a new resource.
    apigw_response_v2_id str
    ID of the API custom response.
    name str
    Specifies the name of the API custom response. The valid length is limited from 1 to 64, letters, digits, hyphens (-) and underscores (_) are allowed.
    rules Sequence[ApigwResponseV2RuleArgs]

    Specifies the API custom response rules definition. The object structure is documented below.

    The rule block supports:

    gatewayId String
    Specifies the ID of the dedicated instance to which the API group and the API custom response belong. Changing this will create a new resource.
    groupId String
    Specifies the ID of the API group to which the API custom response belongs. Changing this will create a new resource.
    apigwResponseV2Id String
    ID of the API custom response.
    name String
    Specifies the name of the API custom response. The valid length is limited from 1 to 64, letters, digits, hyphens (-) and underscores (_) are allowed.
    rules List<Property Map>

    Specifies the API custom response rules definition. The object structure is documented below.

    The rule block supports:

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ApigwResponseV2 resource produces the following output properties:

    CreatedAt string
    The creation time of the API custom response.
    Id string
    The provider-assigned unique ID for this managed resource.
    Region string
    The region where the API custom response is located.
    UpdatedAt string
    The latest update time of the API custom response.
    CreatedAt string
    The creation time of the API custom response.
    Id string
    The provider-assigned unique ID for this managed resource.
    Region string
    The region where the API custom response is located.
    UpdatedAt string
    The latest update time of the API custom response.
    createdAt String
    The creation time of the API custom response.
    id String
    The provider-assigned unique ID for this managed resource.
    region String
    The region where the API custom response is located.
    updatedAt String
    The latest update time of the API custom response.
    createdAt string
    The creation time of the API custom response.
    id string
    The provider-assigned unique ID for this managed resource.
    region string
    The region where the API custom response is located.
    updatedAt string
    The latest update time of the API custom response.
    created_at str
    The creation time of the API custom response.
    id str
    The provider-assigned unique ID for this managed resource.
    region str
    The region where the API custom response is located.
    updated_at str
    The latest update time of the API custom response.
    createdAt String
    The creation time of the API custom response.
    id String
    The provider-assigned unique ID for this managed resource.
    region String
    The region where the API custom response is located.
    updatedAt String
    The latest update time of the API custom response.

    Look up Existing ApigwResponseV2 Resource

    Get an existing ApigwResponseV2 resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ApigwResponseV2State, opts?: CustomResourceOptions): ApigwResponseV2
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        apigw_response_v2_id: Optional[str] = None,
        created_at: Optional[str] = None,
        gateway_id: Optional[str] = None,
        group_id: Optional[str] = None,
        name: Optional[str] = None,
        region: Optional[str] = None,
        rules: Optional[Sequence[ApigwResponseV2RuleArgs]] = None,
        updated_at: Optional[str] = None) -> ApigwResponseV2
    func GetApigwResponseV2(ctx *Context, name string, id IDInput, state *ApigwResponseV2State, opts ...ResourceOption) (*ApigwResponseV2, error)
    public static ApigwResponseV2 Get(string name, Input<string> id, ApigwResponseV2State? state, CustomResourceOptions? opts = null)
    public static ApigwResponseV2 get(String name, Output<String> id, ApigwResponseV2State state, CustomResourceOptions options)
    resources:  _:    type: opentelekomcloud:ApigwResponseV2    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApigwResponseV2Id string
    ID of the API custom response.
    CreatedAt string
    The creation time of the API custom response.
    GatewayId string
    Specifies the ID of the dedicated instance to which the API group and the API custom response belong. Changing this will create a new resource.
    GroupId string
    Specifies the ID of the API group to which the API custom response belongs. Changing this will create a new resource.
    Name string
    Specifies the name of the API custom response. The valid length is limited from 1 to 64, letters, digits, hyphens (-) and underscores (_) are allowed.
    Region string
    The region where the API custom response is located.
    Rules List<ApigwResponseV2Rule>

    Specifies the API custom response rules definition. The object structure is documented below.

    The rule block supports:

    UpdatedAt string
    The latest update time of the API custom response.
    ApigwResponseV2Id string
    ID of the API custom response.
    CreatedAt string
    The creation time of the API custom response.
    GatewayId string
    Specifies the ID of the dedicated instance to which the API group and the API custom response belong. Changing this will create a new resource.
    GroupId string
    Specifies the ID of the API group to which the API custom response belongs. Changing this will create a new resource.
    Name string
    Specifies the name of the API custom response. The valid length is limited from 1 to 64, letters, digits, hyphens (-) and underscores (_) are allowed.
    Region string
    The region where the API custom response is located.
    Rules []ApigwResponseV2RuleArgs

    Specifies the API custom response rules definition. The object structure is documented below.

    The rule block supports:

    UpdatedAt string
    The latest update time of the API custom response.
    apigwResponseV2Id String
    ID of the API custom response.
    createdAt String
    The creation time of the API custom response.
    gatewayId String
    Specifies the ID of the dedicated instance to which the API group and the API custom response belong. Changing this will create a new resource.
    groupId String
    Specifies the ID of the API group to which the API custom response belongs. Changing this will create a new resource.
    name String
    Specifies the name of the API custom response. The valid length is limited from 1 to 64, letters, digits, hyphens (-) and underscores (_) are allowed.
    region String
    The region where the API custom response is located.
    rules List<ApigwResponseV2Rule>

    Specifies the API custom response rules definition. The object structure is documented below.

    The rule block supports:

    updatedAt String
    The latest update time of the API custom response.
    apigwResponseV2Id string
    ID of the API custom response.
    createdAt string
    The creation time of the API custom response.
    gatewayId string
    Specifies the ID of the dedicated instance to which the API group and the API custom response belong. Changing this will create a new resource.
    groupId string
    Specifies the ID of the API group to which the API custom response belongs. Changing this will create a new resource.
    name string
    Specifies the name of the API custom response. The valid length is limited from 1 to 64, letters, digits, hyphens (-) and underscores (_) are allowed.
    region string
    The region where the API custom response is located.
    rules ApigwResponseV2Rule[]

    Specifies the API custom response rules definition. The object structure is documented below.

    The rule block supports:

    updatedAt string
    The latest update time of the API custom response.
    apigw_response_v2_id str
    ID of the API custom response.
    created_at str
    The creation time of the API custom response.
    gateway_id str
    Specifies the ID of the dedicated instance to which the API group and the API custom response belong. Changing this will create a new resource.
    group_id str
    Specifies the ID of the API group to which the API custom response belongs. Changing this will create a new resource.
    name str
    Specifies the name of the API custom response. The valid length is limited from 1 to 64, letters, digits, hyphens (-) and underscores (_) are allowed.
    region str
    The region where the API custom response is located.
    rules Sequence[ApigwResponseV2RuleArgs]

    Specifies the API custom response rules definition. The object structure is documented below.

    The rule block supports:

    updated_at str
    The latest update time of the API custom response.
    apigwResponseV2Id String
    ID of the API custom response.
    createdAt String
    The creation time of the API custom response.
    gatewayId String
    Specifies the ID of the dedicated instance to which the API group and the API custom response belong. Changing this will create a new resource.
    groupId String
    Specifies the ID of the API group to which the API custom response belongs. Changing this will create a new resource.
    name String
    Specifies the name of the API custom response. The valid length is limited from 1 to 64, letters, digits, hyphens (-) and underscores (_) are allowed.
    region String
    The region where the API custom response is located.
    rules List<Property Map>

    Specifies the API custom response rules definition. The object structure is documented below.

    The rule block supports:

    updatedAt String
    The latest update time of the API custom response.

    Supporting Types

    ApigwResponseV2Rule, ApigwResponseV2RuleArgs

    Body string
    Specifies the body template of the API response rule, e.g. {\"code\":\"$context.authorizer.frontend.code\",\"message\":\"$context.authorizer.frontend.message\"}
    ErrorType string
    Specifies the error type of the API response rule. The valid values and the related default status code are as follows:

    • ACCESS_DENIED: (403) Access denied.
    • AUTH_FAILURE: (401) Authentication failed.
    • AUTH_HEADER_MISSING: (401) The identity source is missing.
    • AUTHORIZER_CONF_FAILURE: (500) There has been a custom authorizer error.
    • AUTHORIZER_FAILURE: (500) Custom authentication failed.
    • AUTHORIZER_IDENTITIES_FAILURE: (401) The identity source of the custom authorizer is invalid.
    • BACKEND_TIMEOUT: (504) Communication with the backend service timed out.
    • BACKEND_UNAVAILABLE: (502) The backend service is unavailable.
    • NOT_FOUND: (404) No API is found.
    • REQUEST_PARAMETERS_FAILURE: (400) The request parameters are incorrect.
    • THROTTLED: (429) The request was rejected due to request throttling.
    • UNAUTHORIZED: (401) The app you are using has not been authorized to call the API.
    • DEFAULT_4XX: (NONE) Another 4XX error occurred.
    • DEFAULT_5XX: (NONE) Another 5XX error occurred.
    • THIRD_AUTH_CONF_FAILURE: (500) Third-party authorizer configuration error.
    • THIRD_AUTH_FAILURE: (401) Third-party authentication failed.
    • THIRD_AUTH_IDENTITIES_FAILURE: (401) Identity source of the third-party authorizer is invalid.
    StatusCode double
    Specifies the HTTP status code of the API response rule.
    Body string
    Specifies the body template of the API response rule, e.g. {\"code\":\"$context.authorizer.frontend.code\",\"message\":\"$context.authorizer.frontend.message\"}
    ErrorType string
    Specifies the error type of the API response rule. The valid values and the related default status code are as follows:

    • ACCESS_DENIED: (403) Access denied.
    • AUTH_FAILURE: (401) Authentication failed.
    • AUTH_HEADER_MISSING: (401) The identity source is missing.
    • AUTHORIZER_CONF_FAILURE: (500) There has been a custom authorizer error.
    • AUTHORIZER_FAILURE: (500) Custom authentication failed.
    • AUTHORIZER_IDENTITIES_FAILURE: (401) The identity source of the custom authorizer is invalid.
    • BACKEND_TIMEOUT: (504) Communication with the backend service timed out.
    • BACKEND_UNAVAILABLE: (502) The backend service is unavailable.
    • NOT_FOUND: (404) No API is found.
    • REQUEST_PARAMETERS_FAILURE: (400) The request parameters are incorrect.
    • THROTTLED: (429) The request was rejected due to request throttling.
    • UNAUTHORIZED: (401) The app you are using has not been authorized to call the API.
    • DEFAULT_4XX: (NONE) Another 4XX error occurred.
    • DEFAULT_5XX: (NONE) Another 5XX error occurred.
    • THIRD_AUTH_CONF_FAILURE: (500) Third-party authorizer configuration error.
    • THIRD_AUTH_FAILURE: (401) Third-party authentication failed.
    • THIRD_AUTH_IDENTITIES_FAILURE: (401) Identity source of the third-party authorizer is invalid.
    StatusCode float64
    Specifies the HTTP status code of the API response rule.
    body String
    Specifies the body template of the API response rule, e.g. {\"code\":\"$context.authorizer.frontend.code\",\"message\":\"$context.authorizer.frontend.message\"}
    errorType String
    Specifies the error type of the API response rule. The valid values and the related default status code are as follows:

    • ACCESS_DENIED: (403) Access denied.
    • AUTH_FAILURE: (401) Authentication failed.
    • AUTH_HEADER_MISSING: (401) The identity source is missing.
    • AUTHORIZER_CONF_FAILURE: (500) There has been a custom authorizer error.
    • AUTHORIZER_FAILURE: (500) Custom authentication failed.
    • AUTHORIZER_IDENTITIES_FAILURE: (401) The identity source of the custom authorizer is invalid.
    • BACKEND_TIMEOUT: (504) Communication with the backend service timed out.
    • BACKEND_UNAVAILABLE: (502) The backend service is unavailable.
    • NOT_FOUND: (404) No API is found.
    • REQUEST_PARAMETERS_FAILURE: (400) The request parameters are incorrect.
    • THROTTLED: (429) The request was rejected due to request throttling.
    • UNAUTHORIZED: (401) The app you are using has not been authorized to call the API.
    • DEFAULT_4XX: (NONE) Another 4XX error occurred.
    • DEFAULT_5XX: (NONE) Another 5XX error occurred.
    • THIRD_AUTH_CONF_FAILURE: (500) Third-party authorizer configuration error.
    • THIRD_AUTH_FAILURE: (401) Third-party authentication failed.
    • THIRD_AUTH_IDENTITIES_FAILURE: (401) Identity source of the third-party authorizer is invalid.
    statusCode Double
    Specifies the HTTP status code of the API response rule.
    body string
    Specifies the body template of the API response rule, e.g. {\"code\":\"$context.authorizer.frontend.code\",\"message\":\"$context.authorizer.frontend.message\"}
    errorType string
    Specifies the error type of the API response rule. The valid values and the related default status code are as follows:

    • ACCESS_DENIED: (403) Access denied.
    • AUTH_FAILURE: (401) Authentication failed.
    • AUTH_HEADER_MISSING: (401) The identity source is missing.
    • AUTHORIZER_CONF_FAILURE: (500) There has been a custom authorizer error.
    • AUTHORIZER_FAILURE: (500) Custom authentication failed.
    • AUTHORIZER_IDENTITIES_FAILURE: (401) The identity source of the custom authorizer is invalid.
    • BACKEND_TIMEOUT: (504) Communication with the backend service timed out.
    • BACKEND_UNAVAILABLE: (502) The backend service is unavailable.
    • NOT_FOUND: (404) No API is found.
    • REQUEST_PARAMETERS_FAILURE: (400) The request parameters are incorrect.
    • THROTTLED: (429) The request was rejected due to request throttling.
    • UNAUTHORIZED: (401) The app you are using has not been authorized to call the API.
    • DEFAULT_4XX: (NONE) Another 4XX error occurred.
    • DEFAULT_5XX: (NONE) Another 5XX error occurred.
    • THIRD_AUTH_CONF_FAILURE: (500) Third-party authorizer configuration error.
    • THIRD_AUTH_FAILURE: (401) Third-party authentication failed.
    • THIRD_AUTH_IDENTITIES_FAILURE: (401) Identity source of the third-party authorizer is invalid.
    statusCode number
    Specifies the HTTP status code of the API response rule.
    body str
    Specifies the body template of the API response rule, e.g. {\"code\":\"$context.authorizer.frontend.code\",\"message\":\"$context.authorizer.frontend.message\"}
    error_type str
    Specifies the error type of the API response rule. The valid values and the related default status code are as follows:

    • ACCESS_DENIED: (403) Access denied.
    • AUTH_FAILURE: (401) Authentication failed.
    • AUTH_HEADER_MISSING: (401) The identity source is missing.
    • AUTHORIZER_CONF_FAILURE: (500) There has been a custom authorizer error.
    • AUTHORIZER_FAILURE: (500) Custom authentication failed.
    • AUTHORIZER_IDENTITIES_FAILURE: (401) The identity source of the custom authorizer is invalid.
    • BACKEND_TIMEOUT: (504) Communication with the backend service timed out.
    • BACKEND_UNAVAILABLE: (502) The backend service is unavailable.
    • NOT_FOUND: (404) No API is found.
    • REQUEST_PARAMETERS_FAILURE: (400) The request parameters are incorrect.
    • THROTTLED: (429) The request was rejected due to request throttling.
    • UNAUTHORIZED: (401) The app you are using has not been authorized to call the API.
    • DEFAULT_4XX: (NONE) Another 4XX error occurred.
    • DEFAULT_5XX: (NONE) Another 5XX error occurred.
    • THIRD_AUTH_CONF_FAILURE: (500) Third-party authorizer configuration error.
    • THIRD_AUTH_FAILURE: (401) Third-party authentication failed.
    • THIRD_AUTH_IDENTITIES_FAILURE: (401) Identity source of the third-party authorizer is invalid.
    status_code float
    Specifies the HTTP status code of the API response rule.
    body String
    Specifies the body template of the API response rule, e.g. {\"code\":\"$context.authorizer.frontend.code\",\"message\":\"$context.authorizer.frontend.message\"}
    errorType String
    Specifies the error type of the API response rule. The valid values and the related default status code are as follows:

    • ACCESS_DENIED: (403) Access denied.
    • AUTH_FAILURE: (401) Authentication failed.
    • AUTH_HEADER_MISSING: (401) The identity source is missing.
    • AUTHORIZER_CONF_FAILURE: (500) There has been a custom authorizer error.
    • AUTHORIZER_FAILURE: (500) Custom authentication failed.
    • AUTHORIZER_IDENTITIES_FAILURE: (401) The identity source of the custom authorizer is invalid.
    • BACKEND_TIMEOUT: (504) Communication with the backend service timed out.
    • BACKEND_UNAVAILABLE: (502) The backend service is unavailable.
    • NOT_FOUND: (404) No API is found.
    • REQUEST_PARAMETERS_FAILURE: (400) The request parameters are incorrect.
    • THROTTLED: (429) The request was rejected due to request throttling.
    • UNAUTHORIZED: (401) The app you are using has not been authorized to call the API.
    • DEFAULT_4XX: (NONE) Another 4XX error occurred.
    • DEFAULT_5XX: (NONE) Another 5XX error occurred.
    • THIRD_AUTH_CONF_FAILURE: (500) Third-party authorizer configuration error.
    • THIRD_AUTH_FAILURE: (401) Third-party authentication failed.
    • THIRD_AUTH_IDENTITIES_FAILURE: (401) Identity source of the third-party authorizer is invalid.
    statusCode Number
    Specifies the HTTP status code of the API response rule.

    Import

    API Responses can be imported using their name and IDs of the APIGW dedicated instances and API groups to which the API

    response belongs, separated by slashes, e.g.

    $ pulumi import opentelekomcloud:index/apigwResponseV2:ApigwResponseV2 test <gateway_id>/<group_id>/<name>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    opentelekomcloud opentelekomcloud/terraform-provider-opentelekomcloud
    License
    Notes
    This Pulumi package is based on the opentelekomcloud Terraform Provider.
    opentelekomcloud logo
    opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud
    opentelekomcloud/terraform-provider-opentelekomcloud