Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Opentelekomcloud Provider
  3. API Docs
  4. ApigwThrottlingPolicyV2
opentelekomcloud 1.36.35 published on Monday, Apr 14, 2025 by opentelekomcloud
opentelekomcloud/terraform-provider-opentelekomcloud

opentelekomcloud.ApigwThrottlingPolicyV2

Explore with Pulumi AI

opentelekomcloud 1.36.35 published on Monday, Apr 14, 2025 by opentelekomcloud
opentelekomcloud/terraform-provider-opentelekomcloud

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

API Gateway (APIG) is a high-performance, high-availability, and high-security API hosting service that helps you build, manage, and deploy APIs at any scale. With just a few clicks, you can integrate internal systems, and selectively expose capabilities with minimal costs and risks.

Example Usage

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

const policy = new opentelekomcloud.ApigwThrottlingPolicyV2("policy", {
    instanceId: opentelekomcloud_apigw_gateway_v2.gateway.id,
    type: "API-shared",
    period: 10,
    periodUnit: "MINUTE",
    maxApiRequests: 70,
    maxUserRequests: 45,
    maxAppRequests: 45,
    maxIpRequests: 45,
    description: "Created by tf",
});
Copy
import pulumi
import pulumi_opentelekomcloud as opentelekomcloud

policy = opentelekomcloud.ApigwThrottlingPolicyV2("policy",
    instance_id=opentelekomcloud_apigw_gateway_v2["gateway"]["id"],
    type="API-shared",
    period=10,
    period_unit="MINUTE",
    max_api_requests=70,
    max_user_requests=45,
    max_app_requests=45,
    max_ip_requests=45,
    description="Created by tf")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := opentelekomcloud.NewApigwThrottlingPolicyV2(ctx, "policy", &opentelekomcloud.ApigwThrottlingPolicyV2Args{
			InstanceId:      pulumi.Any(opentelekomcloud_apigw_gateway_v2.Gateway.Id),
			Type:            pulumi.String("API-shared"),
			Period:          pulumi.Float64(10),
			PeriodUnit:      pulumi.String("MINUTE"),
			MaxApiRequests:  pulumi.Float64(70),
			MaxUserRequests: pulumi.Float64(45),
			MaxAppRequests:  pulumi.Float64(45),
			MaxIpRequests:   pulumi.Float64(45),
			Description:     pulumi.String("Created by tf"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Opentelekomcloud = Pulumi.Opentelekomcloud;

return await Deployment.RunAsync(() => 
{
    var policy = new Opentelekomcloud.ApigwThrottlingPolicyV2("policy", new()
    {
        InstanceId = opentelekomcloud_apigw_gateway_v2.Gateway.Id,
        Type = "API-shared",
        Period = 10,
        PeriodUnit = "MINUTE",
        MaxApiRequests = 70,
        MaxUserRequests = 45,
        MaxAppRequests = 45,
        MaxIpRequests = 45,
        Description = "Created by tf",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opentelekomcloud.ApigwThrottlingPolicyV2;
import com.pulumi.opentelekomcloud.ApigwThrottlingPolicyV2Args;
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) {
        var policy = new ApigwThrottlingPolicyV2("policy", ApigwThrottlingPolicyV2Args.builder()
            .instanceId(opentelekomcloud_apigw_gateway_v2.gateway().id())
            .type("API-shared")
            .period(10)
            .periodUnit("MINUTE")
            .maxApiRequests(70)
            .maxUserRequests(45)
            .maxAppRequests(45)
            .maxIpRequests(45)
            .description("Created by tf")
            .build());

    }
}
Copy
resources:
  policy:
    type: opentelekomcloud:ApigwThrottlingPolicyV2
    properties:
      instanceId: ${opentelekomcloud_apigw_gateway_v2.gateway.id}
      type: API-shared
      period: 10
      periodUnit: MINUTE
      maxApiRequests: 70
      maxUserRequests: 45
      maxAppRequests: 45
      maxIpRequests: 45
      description: Created by tf
Copy

Create ApigwThrottlingPolicyV2 Resource

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

Constructor syntax

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

@overload
def ApigwThrottlingPolicyV2(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            period: Optional[float] = None,
                            instance_id: Optional[str] = None,
                            max_api_requests: Optional[float] = None,
                            app_throttles: Optional[Sequence[ApigwThrottlingPolicyV2AppThrottleArgs]] = None,
                            description: Optional[str] = None,
                            max_app_requests: Optional[float] = None,
                            max_ip_requests: Optional[float] = None,
                            max_user_requests: Optional[float] = None,
                            name: Optional[str] = None,
                            apigw_throttling_policy_v2_id: Optional[str] = None,
                            period_unit: Optional[str] = None,
                            type: Optional[str] = None,
                            user_throttles: Optional[Sequence[ApigwThrottlingPolicyV2UserThrottleArgs]] = None)
func NewApigwThrottlingPolicyV2(ctx *Context, name string, args ApigwThrottlingPolicyV2Args, opts ...ResourceOption) (*ApigwThrottlingPolicyV2, error)
public ApigwThrottlingPolicyV2(string name, ApigwThrottlingPolicyV2Args args, CustomResourceOptions? opts = null)
public ApigwThrottlingPolicyV2(String name, ApigwThrottlingPolicyV2Args args)
public ApigwThrottlingPolicyV2(String name, ApigwThrottlingPolicyV2Args args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ApigwThrottlingPolicyV2Args
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ApigwThrottlingPolicyV2Args
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ApigwThrottlingPolicyV2Args
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ApigwThrottlingPolicyV2Args
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ApigwThrottlingPolicyV2Args
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 apigwThrottlingPolicyV2Resource = new Opentelekomcloud.ApigwThrottlingPolicyV2("apigwThrottlingPolicyV2Resource", new()
{
    Period = 0,
    InstanceId = "string",
    MaxApiRequests = 0,
    AppThrottles = new[]
    {
        new Opentelekomcloud.Inputs.ApigwThrottlingPolicyV2AppThrottleArgs
        {
            MaxApiRequests = 0,
            ThrottlingObjectId = "string",
            Id = "string",
            ThrottlingObjectName = "string",
        },
    },
    Description = "string",
    MaxAppRequests = 0,
    MaxIpRequests = 0,
    MaxUserRequests = 0,
    Name = "string",
    ApigwThrottlingPolicyV2Id = "string",
    PeriodUnit = "string",
    Type = "string",
    UserThrottles = new[]
    {
        new Opentelekomcloud.Inputs.ApigwThrottlingPolicyV2UserThrottleArgs
        {
            MaxApiRequests = 0,
            ThrottlingObjectId = "string",
            Id = "string",
            ThrottlingObjectName = "string",
        },
    },
});
Copy
example, err := opentelekomcloud.NewApigwThrottlingPolicyV2(ctx, "apigwThrottlingPolicyV2Resource", &opentelekomcloud.ApigwThrottlingPolicyV2Args{
Period: pulumi.Float64(0),
InstanceId: pulumi.String("string"),
MaxApiRequests: pulumi.Float64(0),
AppThrottles: .ApigwThrottlingPolicyV2AppThrottleArray{
&.ApigwThrottlingPolicyV2AppThrottleArgs{
MaxApiRequests: pulumi.Float64(0),
ThrottlingObjectId: pulumi.String("string"),
Id: pulumi.String("string"),
ThrottlingObjectName: pulumi.String("string"),
},
},
Description: pulumi.String("string"),
MaxAppRequests: pulumi.Float64(0),
MaxIpRequests: pulumi.Float64(0),
MaxUserRequests: pulumi.Float64(0),
Name: pulumi.String("string"),
ApigwThrottlingPolicyV2Id: pulumi.String("string"),
PeriodUnit: pulumi.String("string"),
Type: pulumi.String("string"),
UserThrottles: .ApigwThrottlingPolicyV2UserThrottleArray{
&.ApigwThrottlingPolicyV2UserThrottleArgs{
MaxApiRequests: pulumi.Float64(0),
ThrottlingObjectId: pulumi.String("string"),
Id: pulumi.String("string"),
ThrottlingObjectName: pulumi.String("string"),
},
},
})
Copy
var apigwThrottlingPolicyV2Resource = new ApigwThrottlingPolicyV2("apigwThrottlingPolicyV2Resource", ApigwThrottlingPolicyV2Args.builder()
    .period(0)
    .instanceId("string")
    .maxApiRequests(0)
    .appThrottles(ApigwThrottlingPolicyV2AppThrottleArgs.builder()
        .maxApiRequests(0)
        .throttlingObjectId("string")
        .id("string")
        .throttlingObjectName("string")
        .build())
    .description("string")
    .maxAppRequests(0)
    .maxIpRequests(0)
    .maxUserRequests(0)
    .name("string")
    .apigwThrottlingPolicyV2Id("string")
    .periodUnit("string")
    .type("string")
    .userThrottles(ApigwThrottlingPolicyV2UserThrottleArgs.builder()
        .maxApiRequests(0)
        .throttlingObjectId("string")
        .id("string")
        .throttlingObjectName("string")
        .build())
    .build());
Copy
apigw_throttling_policy_v2_resource = opentelekomcloud.ApigwThrottlingPolicyV2("apigwThrottlingPolicyV2Resource",
    period=0,
    instance_id="string",
    max_api_requests=0,
    app_throttles=[{
        "max_api_requests": 0,
        "throttling_object_id": "string",
        "id": "string",
        "throttling_object_name": "string",
    }],
    description="string",
    max_app_requests=0,
    max_ip_requests=0,
    max_user_requests=0,
    name="string",
    apigw_throttling_policy_v2_id="string",
    period_unit="string",
    type="string",
    user_throttles=[{
        "max_api_requests": 0,
        "throttling_object_id": "string",
        "id": "string",
        "throttling_object_name": "string",
    }])
Copy
const apigwThrottlingPolicyV2Resource = new opentelekomcloud.ApigwThrottlingPolicyV2("apigwThrottlingPolicyV2Resource", {
    period: 0,
    instanceId: "string",
    maxApiRequests: 0,
    appThrottles: [{
        maxApiRequests: 0,
        throttlingObjectId: "string",
        id: "string",
        throttlingObjectName: "string",
    }],
    description: "string",
    maxAppRequests: 0,
    maxIpRequests: 0,
    maxUserRequests: 0,
    name: "string",
    apigwThrottlingPolicyV2Id: "string",
    periodUnit: "string",
    type: "string",
    userThrottles: [{
        maxApiRequests: 0,
        throttlingObjectId: "string",
        id: "string",
        throttlingObjectName: "string",
    }],
});
Copy
type: opentelekomcloud:ApigwThrottlingPolicyV2
properties:
    apigwThrottlingPolicyV2Id: string
    appThrottles:
        - id: string
          maxApiRequests: 0
          throttlingObjectId: string
          throttlingObjectName: string
    description: string
    instanceId: string
    maxApiRequests: 0
    maxAppRequests: 0
    maxIpRequests: 0
    maxUserRequests: 0
    name: string
    period: 0
    periodUnit: string
    type: string
    userThrottles:
        - id: string
          maxApiRequests: 0
          throttlingObjectId: string
          throttlingObjectName: string
Copy

ApigwThrottlingPolicyV2 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 ApigwThrottlingPolicyV2 resource accepts the following input properties:

InstanceId This property is required. string
Specifies the ID of the dedicated instance to which the throttling policy belongs.
MaxApiRequests This property is required. double
Specifies the maximum number of times an API can be accessed within a specified period.
Period This property is required. double
Specifies the period of time for limiting the number of API calls. This parameter applies with each of the API call limits: max_api_requests, max_app_requests, max_ip_requests and max_user_requests.
ApigwThrottlingPolicyV2Id string
ID of the special user/application throttling policy.
AppThrottles List<ApigwThrottlingPolicyV2AppThrottle>

Specifies the array of one or more special throttling policies for APP limit. The app_throttles object structure is documented below.

The user_throttles and user_throttles blocks support:

Description string
Specifies the description about the API throttling policy. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.
MaxAppRequests double
Specifies the maximum number of times the API can be accessed by an app within the same period. The value of this parameter must be less than or equal to the value of max_user_requests.
MaxIpRequests double
Specifies the maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
MaxUserRequests double
Specifies the maximum number of times the API can be accessed by a user within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
Name string
Specifies the name of the throttling policy. The valid length is limited from 3 to 64, only English letters, digits and underscores (_) are allowed.
PeriodUnit string
Specifies the time unit for limiting the number of API calls. The valid values are SECOND, MINUTE, HOUR and DAY, defaults to MINUTE.
Type string
Specifies the type of the request throttling policy. The valid values are as follows:

  • API-based: limiting the maximum number of times a single API bound to the policy can be called within the specified period.
  • API-shared: limiting the maximum number of times all APIs bound to the policy can be called within the specified period.
UserThrottles List<ApigwThrottlingPolicyV2UserThrottle>
Specifies the array of one or more special throttling policies for IAM user limit. The user_throttles object structure is documented below.
InstanceId This property is required. string
Specifies the ID of the dedicated instance to which the throttling policy belongs.
MaxApiRequests This property is required. float64
Specifies the maximum number of times an API can be accessed within a specified period.
Period This property is required. float64
Specifies the period of time for limiting the number of API calls. This parameter applies with each of the API call limits: max_api_requests, max_app_requests, max_ip_requests and max_user_requests.
ApigwThrottlingPolicyV2Id string
ID of the special user/application throttling policy.
AppThrottles []ApigwThrottlingPolicyV2AppThrottleArgs

Specifies the array of one or more special throttling policies for APP limit. The app_throttles object structure is documented below.

The user_throttles and user_throttles blocks support:

Description string
Specifies the description about the API throttling policy. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.
MaxAppRequests float64
Specifies the maximum number of times the API can be accessed by an app within the same period. The value of this parameter must be less than or equal to the value of max_user_requests.
MaxIpRequests float64
Specifies the maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
MaxUserRequests float64
Specifies the maximum number of times the API can be accessed by a user within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
Name string
Specifies the name of the throttling policy. The valid length is limited from 3 to 64, only English letters, digits and underscores (_) are allowed.
PeriodUnit string
Specifies the time unit for limiting the number of API calls. The valid values are SECOND, MINUTE, HOUR and DAY, defaults to MINUTE.
Type string
Specifies the type of the request throttling policy. The valid values are as follows:

  • API-based: limiting the maximum number of times a single API bound to the policy can be called within the specified period.
  • API-shared: limiting the maximum number of times all APIs bound to the policy can be called within the specified period.
UserThrottles []ApigwThrottlingPolicyV2UserThrottleArgs
Specifies the array of one or more special throttling policies for IAM user limit. The user_throttles object structure is documented below.
instanceId This property is required. String
Specifies the ID of the dedicated instance to which the throttling policy belongs.
maxApiRequests This property is required. Double
Specifies the maximum number of times an API can be accessed within a specified period.
period This property is required. Double
Specifies the period of time for limiting the number of API calls. This parameter applies with each of the API call limits: max_api_requests, max_app_requests, max_ip_requests and max_user_requests.
apigwThrottlingPolicyV2Id String
ID of the special user/application throttling policy.
appThrottles List<ApigwThrottlingPolicyV2AppThrottle>

Specifies the array of one or more special throttling policies for APP limit. The app_throttles object structure is documented below.

The user_throttles and user_throttles blocks support:

description String
Specifies the description about the API throttling policy. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.
maxAppRequests Double
Specifies the maximum number of times the API can be accessed by an app within the same period. The value of this parameter must be less than or equal to the value of max_user_requests.
maxIpRequests Double
Specifies the maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
maxUserRequests Double
Specifies the maximum number of times the API can be accessed by a user within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
name String
Specifies the name of the throttling policy. The valid length is limited from 3 to 64, only English letters, digits and underscores (_) are allowed.
periodUnit String
Specifies the time unit for limiting the number of API calls. The valid values are SECOND, MINUTE, HOUR and DAY, defaults to MINUTE.
type String
Specifies the type of the request throttling policy. The valid values are as follows:

  • API-based: limiting the maximum number of times a single API bound to the policy can be called within the specified period.
  • API-shared: limiting the maximum number of times all APIs bound to the policy can be called within the specified period.
userThrottles List<ApigwThrottlingPolicyV2UserThrottle>
Specifies the array of one or more special throttling policies for IAM user limit. The user_throttles object structure is documented below.
instanceId This property is required. string
Specifies the ID of the dedicated instance to which the throttling policy belongs.
maxApiRequests This property is required. number
Specifies the maximum number of times an API can be accessed within a specified period.
period This property is required. number
Specifies the period of time for limiting the number of API calls. This parameter applies with each of the API call limits: max_api_requests, max_app_requests, max_ip_requests and max_user_requests.
apigwThrottlingPolicyV2Id string
ID of the special user/application throttling policy.
appThrottles ApigwThrottlingPolicyV2AppThrottle[]

Specifies the array of one or more special throttling policies for APP limit. The app_throttles object structure is documented below.

The user_throttles and user_throttles blocks support:

description string
Specifies the description about the API throttling policy. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.
maxAppRequests number
Specifies the maximum number of times the API can be accessed by an app within the same period. The value of this parameter must be less than or equal to the value of max_user_requests.
maxIpRequests number
Specifies the maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
maxUserRequests number
Specifies the maximum number of times the API can be accessed by a user within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
name string
Specifies the name of the throttling policy. The valid length is limited from 3 to 64, only English letters, digits and underscores (_) are allowed.
periodUnit string
Specifies the time unit for limiting the number of API calls. The valid values are SECOND, MINUTE, HOUR and DAY, defaults to MINUTE.
type string
Specifies the type of the request throttling policy. The valid values are as follows:

  • API-based: limiting the maximum number of times a single API bound to the policy can be called within the specified period.
  • API-shared: limiting the maximum number of times all APIs bound to the policy can be called within the specified period.
userThrottles ApigwThrottlingPolicyV2UserThrottle[]
Specifies the array of one or more special throttling policies for IAM user limit. The user_throttles object structure is documented below.
instance_id This property is required. str
Specifies the ID of the dedicated instance to which the throttling policy belongs.
max_api_requests This property is required. float
Specifies the maximum number of times an API can be accessed within a specified period.
period This property is required. float
Specifies the period of time for limiting the number of API calls. This parameter applies with each of the API call limits: max_api_requests, max_app_requests, max_ip_requests and max_user_requests.
apigw_throttling_policy_v2_id str
ID of the special user/application throttling policy.
app_throttles Sequence[ApigwThrottlingPolicyV2AppThrottleArgs]

Specifies the array of one or more special throttling policies for APP limit. The app_throttles object structure is documented below.

The user_throttles and user_throttles blocks support:

description str
Specifies the description about the API throttling policy. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.
max_app_requests float
Specifies the maximum number of times the API can be accessed by an app within the same period. The value of this parameter must be less than or equal to the value of max_user_requests.
max_ip_requests float
Specifies the maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
max_user_requests float
Specifies the maximum number of times the API can be accessed by a user within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
name str
Specifies the name of the throttling policy. The valid length is limited from 3 to 64, only English letters, digits and underscores (_) are allowed.
period_unit str
Specifies the time unit for limiting the number of API calls. The valid values are SECOND, MINUTE, HOUR and DAY, defaults to MINUTE.
type str
Specifies the type of the request throttling policy. The valid values are as follows:

  • API-based: limiting the maximum number of times a single API bound to the policy can be called within the specified period.
  • API-shared: limiting the maximum number of times all APIs bound to the policy can be called within the specified period.
user_throttles Sequence[ApigwThrottlingPolicyV2UserThrottleArgs]
Specifies the array of one or more special throttling policies for IAM user limit. The user_throttles object structure is documented below.
instanceId This property is required. String
Specifies the ID of the dedicated instance to which the throttling policy belongs.
maxApiRequests This property is required. Number
Specifies the maximum number of times an API can be accessed within a specified period.
period This property is required. Number
Specifies the period of time for limiting the number of API calls. This parameter applies with each of the API call limits: max_api_requests, max_app_requests, max_ip_requests and max_user_requests.
apigwThrottlingPolicyV2Id String
ID of the special user/application throttling policy.
appThrottles List<Property Map>

Specifies the array of one or more special throttling policies for APP limit. The app_throttles object structure is documented below.

The user_throttles and user_throttles blocks support:

description String
Specifies the description about the API throttling policy. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.
maxAppRequests Number
Specifies the maximum number of times the API can be accessed by an app within the same period. The value of this parameter must be less than or equal to the value of max_user_requests.
maxIpRequests Number
Specifies the maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
maxUserRequests Number
Specifies the maximum number of times the API can be accessed by a user within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
name String
Specifies the name of the throttling policy. The valid length is limited from 3 to 64, only English letters, digits and underscores (_) are allowed.
periodUnit String
Specifies the time unit for limiting the number of API calls. The valid values are SECOND, MINUTE, HOUR and DAY, defaults to MINUTE.
type String
Specifies the type of the request throttling policy. The valid values are as follows:

  • API-based: limiting the maximum number of times a single API bound to the policy can be called within the specified period.
  • API-shared: limiting the maximum number of times all APIs bound to the policy can be called within the specified period.
userThrottles List<Property Map>
Specifies the array of one or more special throttling policies for IAM user limit. The user_throttles object structure is documented below.

Outputs

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

CreatedAt string
The creation time of the throttling policy.
Id string
The provider-assigned unique ID for this managed resource.
Region string
The region where the throttling policy is located.
CreatedAt string
The creation time of the throttling policy.
Id string
The provider-assigned unique ID for this managed resource.
Region string
The region where the throttling policy is located.
createdAt String
The creation time of the throttling policy.
id String
The provider-assigned unique ID for this managed resource.
region String
The region where the throttling policy is located.
createdAt string
The creation time of the throttling policy.
id string
The provider-assigned unique ID for this managed resource.
region string
The region where the throttling policy is located.
created_at str
The creation time of the throttling policy.
id str
The provider-assigned unique ID for this managed resource.
region str
The region where the throttling policy is located.
createdAt String
The creation time of the throttling policy.
id String
The provider-assigned unique ID for this managed resource.
region String
The region where the throttling policy is located.

Look up Existing ApigwThrottlingPolicyV2 Resource

Get an existing ApigwThrottlingPolicyV2 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?: ApigwThrottlingPolicyV2State, opts?: CustomResourceOptions): ApigwThrottlingPolicyV2
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        apigw_throttling_policy_v2_id: Optional[str] = None,
        app_throttles: Optional[Sequence[ApigwThrottlingPolicyV2AppThrottleArgs]] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        instance_id: Optional[str] = None,
        max_api_requests: Optional[float] = None,
        max_app_requests: Optional[float] = None,
        max_ip_requests: Optional[float] = None,
        max_user_requests: Optional[float] = None,
        name: Optional[str] = None,
        period: Optional[float] = None,
        period_unit: Optional[str] = None,
        region: Optional[str] = None,
        type: Optional[str] = None,
        user_throttles: Optional[Sequence[ApigwThrottlingPolicyV2UserThrottleArgs]] = None) -> ApigwThrottlingPolicyV2
func GetApigwThrottlingPolicyV2(ctx *Context, name string, id IDInput, state *ApigwThrottlingPolicyV2State, opts ...ResourceOption) (*ApigwThrottlingPolicyV2, error)
public static ApigwThrottlingPolicyV2 Get(string name, Input<string> id, ApigwThrottlingPolicyV2State? state, CustomResourceOptions? opts = null)
public static ApigwThrottlingPolicyV2 get(String name, Output<String> id, ApigwThrottlingPolicyV2State state, CustomResourceOptions options)
resources:  _:    type: opentelekomcloud:ApigwThrottlingPolicyV2    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ApigwThrottlingPolicyV2Id string
ID of the special user/application throttling policy.
AppThrottles List<ApigwThrottlingPolicyV2AppThrottle>

Specifies the array of one or more special throttling policies for APP limit. The app_throttles object structure is documented below.

The user_throttles and user_throttles blocks support:

CreatedAt string
The creation time of the throttling policy.
Description string
Specifies the description about the API throttling policy. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.
InstanceId string
Specifies the ID of the dedicated instance to which the throttling policy belongs.
MaxApiRequests double
Specifies the maximum number of times an API can be accessed within a specified period.
MaxAppRequests double
Specifies the maximum number of times the API can be accessed by an app within the same period. The value of this parameter must be less than or equal to the value of max_user_requests.
MaxIpRequests double
Specifies the maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
MaxUserRequests double
Specifies the maximum number of times the API can be accessed by a user within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
Name string
Specifies the name of the throttling policy. The valid length is limited from 3 to 64, only English letters, digits and underscores (_) are allowed.
Period double
Specifies the period of time for limiting the number of API calls. This parameter applies with each of the API call limits: max_api_requests, max_app_requests, max_ip_requests and max_user_requests.
PeriodUnit string
Specifies the time unit for limiting the number of API calls. The valid values are SECOND, MINUTE, HOUR and DAY, defaults to MINUTE.
Region string
The region where the throttling policy is located.
Type string
Specifies the type of the request throttling policy. The valid values are as follows:

  • API-based: limiting the maximum number of times a single API bound to the policy can be called within the specified period.
  • API-shared: limiting the maximum number of times all APIs bound to the policy can be called within the specified period.
UserThrottles List<ApigwThrottlingPolicyV2UserThrottle>
Specifies the array of one or more special throttling policies for IAM user limit. The user_throttles object structure is documented below.
ApigwThrottlingPolicyV2Id string
ID of the special user/application throttling policy.
AppThrottles []ApigwThrottlingPolicyV2AppThrottleArgs

Specifies the array of one or more special throttling policies for APP limit. The app_throttles object structure is documented below.

The user_throttles and user_throttles blocks support:

CreatedAt string
The creation time of the throttling policy.
Description string
Specifies the description about the API throttling policy. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.
InstanceId string
Specifies the ID of the dedicated instance to which the throttling policy belongs.
MaxApiRequests float64
Specifies the maximum number of times an API can be accessed within a specified period.
MaxAppRequests float64
Specifies the maximum number of times the API can be accessed by an app within the same period. The value of this parameter must be less than or equal to the value of max_user_requests.
MaxIpRequests float64
Specifies the maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
MaxUserRequests float64
Specifies the maximum number of times the API can be accessed by a user within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
Name string
Specifies the name of the throttling policy. The valid length is limited from 3 to 64, only English letters, digits and underscores (_) are allowed.
Period float64
Specifies the period of time for limiting the number of API calls. This parameter applies with each of the API call limits: max_api_requests, max_app_requests, max_ip_requests and max_user_requests.
PeriodUnit string
Specifies the time unit for limiting the number of API calls. The valid values are SECOND, MINUTE, HOUR and DAY, defaults to MINUTE.
Region string
The region where the throttling policy is located.
Type string
Specifies the type of the request throttling policy. The valid values are as follows:

  • API-based: limiting the maximum number of times a single API bound to the policy can be called within the specified period.
  • API-shared: limiting the maximum number of times all APIs bound to the policy can be called within the specified period.
UserThrottles []ApigwThrottlingPolicyV2UserThrottleArgs
Specifies the array of one or more special throttling policies for IAM user limit. The user_throttles object structure is documented below.
apigwThrottlingPolicyV2Id String
ID of the special user/application throttling policy.
appThrottles List<ApigwThrottlingPolicyV2AppThrottle>

Specifies the array of one or more special throttling policies for APP limit. The app_throttles object structure is documented below.

The user_throttles and user_throttles blocks support:

createdAt String
The creation time of the throttling policy.
description String
Specifies the description about the API throttling policy. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.
instanceId String
Specifies the ID of the dedicated instance to which the throttling policy belongs.
maxApiRequests Double
Specifies the maximum number of times an API can be accessed within a specified period.
maxAppRequests Double
Specifies the maximum number of times the API can be accessed by an app within the same period. The value of this parameter must be less than or equal to the value of max_user_requests.
maxIpRequests Double
Specifies the maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
maxUserRequests Double
Specifies the maximum number of times the API can be accessed by a user within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
name String
Specifies the name of the throttling policy. The valid length is limited from 3 to 64, only English letters, digits and underscores (_) are allowed.
period Double
Specifies the period of time for limiting the number of API calls. This parameter applies with each of the API call limits: max_api_requests, max_app_requests, max_ip_requests and max_user_requests.
periodUnit String
Specifies the time unit for limiting the number of API calls. The valid values are SECOND, MINUTE, HOUR and DAY, defaults to MINUTE.
region String
The region where the throttling policy is located.
type String
Specifies the type of the request throttling policy. The valid values are as follows:

  • API-based: limiting the maximum number of times a single API bound to the policy can be called within the specified period.
  • API-shared: limiting the maximum number of times all APIs bound to the policy can be called within the specified period.
userThrottles List<ApigwThrottlingPolicyV2UserThrottle>
Specifies the array of one or more special throttling policies for IAM user limit. The user_throttles object structure is documented below.
apigwThrottlingPolicyV2Id string
ID of the special user/application throttling policy.
appThrottles ApigwThrottlingPolicyV2AppThrottle[]

Specifies the array of one or more special throttling policies for APP limit. The app_throttles object structure is documented below.

The user_throttles and user_throttles blocks support:

createdAt string
The creation time of the throttling policy.
description string
Specifies the description about the API throttling policy. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.
instanceId string
Specifies the ID of the dedicated instance to which the throttling policy belongs.
maxApiRequests number
Specifies the maximum number of times an API can be accessed within a specified period.
maxAppRequests number
Specifies the maximum number of times the API can be accessed by an app within the same period. The value of this parameter must be less than or equal to the value of max_user_requests.
maxIpRequests number
Specifies the maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
maxUserRequests number
Specifies the maximum number of times the API can be accessed by a user within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
name string
Specifies the name of the throttling policy. The valid length is limited from 3 to 64, only English letters, digits and underscores (_) are allowed.
period number
Specifies the period of time for limiting the number of API calls. This parameter applies with each of the API call limits: max_api_requests, max_app_requests, max_ip_requests and max_user_requests.
periodUnit string
Specifies the time unit for limiting the number of API calls. The valid values are SECOND, MINUTE, HOUR and DAY, defaults to MINUTE.
region string
The region where the throttling policy is located.
type string
Specifies the type of the request throttling policy. The valid values are as follows:

  • API-based: limiting the maximum number of times a single API bound to the policy can be called within the specified period.
  • API-shared: limiting the maximum number of times all APIs bound to the policy can be called within the specified period.
userThrottles ApigwThrottlingPolicyV2UserThrottle[]
Specifies the array of one or more special throttling policies for IAM user limit. The user_throttles object structure is documented below.
apigw_throttling_policy_v2_id str
ID of the special user/application throttling policy.
app_throttles Sequence[ApigwThrottlingPolicyV2AppThrottleArgs]

Specifies the array of one or more special throttling policies for APP limit. The app_throttles object structure is documented below.

The user_throttles and user_throttles blocks support:

created_at str
The creation time of the throttling policy.
description str
Specifies the description about the API throttling policy. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.
instance_id str
Specifies the ID of the dedicated instance to which the throttling policy belongs.
max_api_requests float
Specifies the maximum number of times an API can be accessed within a specified period.
max_app_requests float
Specifies the maximum number of times the API can be accessed by an app within the same period. The value of this parameter must be less than or equal to the value of max_user_requests.
max_ip_requests float
Specifies the maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
max_user_requests float
Specifies the maximum number of times the API can be accessed by a user within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
name str
Specifies the name of the throttling policy. The valid length is limited from 3 to 64, only English letters, digits and underscores (_) are allowed.
period float
Specifies the period of time for limiting the number of API calls. This parameter applies with each of the API call limits: max_api_requests, max_app_requests, max_ip_requests and max_user_requests.
period_unit str
Specifies the time unit for limiting the number of API calls. The valid values are SECOND, MINUTE, HOUR and DAY, defaults to MINUTE.
region str
The region where the throttling policy is located.
type str
Specifies the type of the request throttling policy. The valid values are as follows:

  • API-based: limiting the maximum number of times a single API bound to the policy can be called within the specified period.
  • API-shared: limiting the maximum number of times all APIs bound to the policy can be called within the specified period.
user_throttles Sequence[ApigwThrottlingPolicyV2UserThrottleArgs]
Specifies the array of one or more special throttling policies for IAM user limit. The user_throttles object structure is documented below.
apigwThrottlingPolicyV2Id String
ID of the special user/application throttling policy.
appThrottles List<Property Map>

Specifies the array of one or more special throttling policies for APP limit. The app_throttles object structure is documented below.

The user_throttles and user_throttles blocks support:

createdAt String
The creation time of the throttling policy.
description String
Specifies the description about the API throttling policy. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.
instanceId String
Specifies the ID of the dedicated instance to which the throttling policy belongs.
maxApiRequests Number
Specifies the maximum number of times an API can be accessed within a specified period.
maxAppRequests Number
Specifies the maximum number of times the API can be accessed by an app within the same period. The value of this parameter must be less than or equal to the value of max_user_requests.
maxIpRequests Number
Specifies the maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
maxUserRequests Number
Specifies the maximum number of times the API can be accessed by a user within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
name String
Specifies the name of the throttling policy. The valid length is limited from 3 to 64, only English letters, digits and underscores (_) are allowed.
period Number
Specifies the period of time for limiting the number of API calls. This parameter applies with each of the API call limits: max_api_requests, max_app_requests, max_ip_requests and max_user_requests.
periodUnit String
Specifies the time unit for limiting the number of API calls. The valid values are SECOND, MINUTE, HOUR and DAY, defaults to MINUTE.
region String
The region where the throttling policy is located.
type String
Specifies the type of the request throttling policy. The valid values are as follows:

  • API-based: limiting the maximum number of times a single API bound to the policy can be called within the specified period.
  • API-shared: limiting the maximum number of times all APIs bound to the policy can be called within the specified period.
userThrottles List<Property Map>
Specifies the array of one or more special throttling policies for IAM user limit. The user_throttles object structure is documented below.

Supporting Types

ApigwThrottlingPolicyV2AppThrottle
, ApigwThrottlingPolicyV2AppThrottleArgs

MaxApiRequests This property is required. double
Specifies the maximum number of times an API can be accessed within a specified period.
ThrottlingObjectId This property is required. string
Specifies the object ID which the special throttling policy belongs.
Id string
ID of the special user/application throttling policy.
ThrottlingObjectName string
The object name which the special user/application throttling policy belongs.
MaxApiRequests This property is required. float64
Specifies the maximum number of times an API can be accessed within a specified period.
ThrottlingObjectId This property is required. string
Specifies the object ID which the special throttling policy belongs.
Id string
ID of the special user/application throttling policy.
ThrottlingObjectName string
The object name which the special user/application throttling policy belongs.
maxApiRequests This property is required. Double
Specifies the maximum number of times an API can be accessed within a specified period.
throttlingObjectId This property is required. String
Specifies the object ID which the special throttling policy belongs.
id String
ID of the special user/application throttling policy.
throttlingObjectName String
The object name which the special user/application throttling policy belongs.
maxApiRequests This property is required. number
Specifies the maximum number of times an API can be accessed within a specified period.
throttlingObjectId This property is required. string
Specifies the object ID which the special throttling policy belongs.
id string
ID of the special user/application throttling policy.
throttlingObjectName string
The object name which the special user/application throttling policy belongs.
max_api_requests This property is required. float
Specifies the maximum number of times an API can be accessed within a specified period.
throttling_object_id This property is required. str
Specifies the object ID which the special throttling policy belongs.
id str
ID of the special user/application throttling policy.
throttling_object_name str
The object name which the special user/application throttling policy belongs.
maxApiRequests This property is required. Number
Specifies the maximum number of times an API can be accessed within a specified period.
throttlingObjectId This property is required. String
Specifies the object ID which the special throttling policy belongs.
id String
ID of the special user/application throttling policy.
throttlingObjectName String
The object name which the special user/application throttling policy belongs.

ApigwThrottlingPolicyV2UserThrottle
, ApigwThrottlingPolicyV2UserThrottleArgs

MaxApiRequests This property is required. double
Specifies the maximum number of times an API can be accessed within a specified period.
ThrottlingObjectId This property is required. string
Specifies the object ID which the special throttling policy belongs.
Id string
ID of the special user/application throttling policy.
ThrottlingObjectName string
The object name which the special user/application throttling policy belongs.
MaxApiRequests This property is required. float64
Specifies the maximum number of times an API can be accessed within a specified period.
ThrottlingObjectId This property is required. string
Specifies the object ID which the special throttling policy belongs.
Id string
ID of the special user/application throttling policy.
ThrottlingObjectName string
The object name which the special user/application throttling policy belongs.
maxApiRequests This property is required. Double
Specifies the maximum number of times an API can be accessed within a specified period.
throttlingObjectId This property is required. String
Specifies the object ID which the special throttling policy belongs.
id String
ID of the special user/application throttling policy.
throttlingObjectName String
The object name which the special user/application throttling policy belongs.
maxApiRequests This property is required. number
Specifies the maximum number of times an API can be accessed within a specified period.
throttlingObjectId This property is required. string
Specifies the object ID which the special throttling policy belongs.
id string
ID of the special user/application throttling policy.
throttlingObjectName string
The object name which the special user/application throttling policy belongs.
max_api_requests This property is required. float
Specifies the maximum number of times an API can be accessed within a specified period.
throttling_object_id This property is required. str
Specifies the object ID which the special throttling policy belongs.
id str
ID of the special user/application throttling policy.
throttling_object_name str
The object name which the special user/application throttling policy belongs.
maxApiRequests This property is required. Number
Specifies the maximum number of times an API can be accessed within a specified period.
throttlingObjectId This property is required. String
Specifies the object ID which the special throttling policy belongs.
id String
ID of the special user/application throttling policy.
throttlingObjectName String
The object name which the special user/application throttling policy belongs.

Import

API Throttling Policies can be imported using their name and related dedicated instance ID, separated by a slash, e.g.

$ pulumi import opentelekomcloud:index/apigwThrottlingPolicyV2:ApigwThrottlingPolicyV2 test <instance_id>/<name>
Copy

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 1.36.35 published on Monday, Apr 14, 2025 by opentelekomcloud
opentelekomcloud/terraform-provider-opentelekomcloud