UsagePlansClient

class oci.apigateway.UsagePlansClient(config, **kwargs)

API for the API Gateway service. Use this API to manage gateways, deployments, and related items. For more information, see [Overview of API Gateway](/iaas/Content/APIGateway/Concepts/apigatewayoverview.htm).

Methods

__init__(config, **kwargs)	Creates a new service client
change_usage_plan_compartment(usage_plan_id, …)	Changes the usage plan compartment.
create_usage_plan(create_usage_plan_details, …)	Creates a new usage plan.
delete_usage_plan(usage_plan_id, **kwargs)	Deletes the usage plan with the given identifier.
get_usage_plan(usage_plan_id, **kwargs)	Gets a usage plan by identifier.
list_usage_plans(compartment_id, **kwargs)	Returns a list of usage plans.
update_usage_plan(usage_plan_id, …)	Updates the usage plan with the given identifier.

__init__(config, **kwargs)

Creates a new service client

Parameters:

• config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
• service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
• timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
• signer (AbstractBaseSigner) –

  (optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

  One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument

• retry_strategy (obj) –

  (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

  This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

• circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
• circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
• client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
• allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

change_usage_plan_compartment(usage_plan_id, change_usage_plan_compartment_details, **kwargs)

Changes the usage plan compartment.

Parameters:

• usage_plan_id (str) – (required) The ocid of the usage plan.
• change_usage_plan_compartment_details (oci.apigateway.models.ChangeUsagePlanCompartmentDetails) – (required) Details of the target compartment.
• opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
• if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
• opc_request_id (str) – (optional) The client request id for tracing.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_usage_plan_compartment API.

create_usage_plan(create_usage_plan_details, **kwargs)

Creates a new usage plan.

Parameters:

• create_usage_plan_details (oci.apigateway.models.CreateUsagePlanDetails) – (required) Details for the new usage plan.
• opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
• opc_request_id (str) – (optional) The client request id for tracing.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type UsagePlan

Return type:

Response

Example:

Click here to see an example of how to use create_usage_plan API.

delete_usage_plan(usage_plan_id, **kwargs)

Deletes the usage plan with the given identifier.

Parameters:

• usage_plan_id (str) – (required) The ocid of the usage plan.
• if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
• opc_request_id (str) – (optional) The client request id for tracing.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_usage_plan API.

get_usage_plan(usage_plan_id, **kwargs)

Gets a usage plan by identifier.

Parameters:

• usage_plan_id (str) – (required) The ocid of the usage plan.
• opc_request_id (str) – (optional) The client request id for tracing.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type UsagePlan

Return type:

Response

Example:

Click here to see an example of how to use get_usage_plan API.

list_usage_plans(compartment_id, **kwargs)

Returns a list of usage plans.

Parameters:

• compartment_id (str) – (required) The ocid of the compartment in which to list resources.
• display_name (str) –

  (optional) A user-friendly name. Does not have to be unique, and it’s changeable.

  Example: My new resource

• lifecycle_state (str) –

  (optional) A filter to return only resources that match the given lifecycle state. Example: ACTIVE

  Allowed values are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”

• limit (int) – (optional) The maximum number of items to return.
• page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
• sort_order (str) –

  (optional) The sort order to use, either ‘asc’ or ‘desc’. The default order depends on the sortBy value.

  Allowed values are: “ASC”, “DESC”

• sort_by (str) –

  (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for timeCreated is descending. Default order for displayName is ascending. The displayName sort order is case sensitive.

  Allowed values are: “timeCreated”, “displayName”

• opc_request_id (str) – (optional) The client request id for tracing.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type UsagePlanCollection

Return type:

Response

Example:

Click here to see an example of how to use list_usage_plans API.

update_usage_plan(usage_plan_id, update_usage_plan_details, **kwargs)

Updates the usage plan with the given identifier.

Parameters:

• usage_plan_id (str) – (required) The ocid of the usage plan.
• update_usage_plan_details (oci.apigateway.models.UpdateUsagePlanDetails) – (required) The information to be updated.
• if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
• opc_request_id (str) – (optional) The client request id for tracing.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use update_usage_plan API.