Data Source: oci_apigateway_api

This data source provides details about a specific Api resource in Oracle Cloud Infrastructure API Gateway service.

Gets an API by identifier.

Example Usage

data "oci_apigateway_api" "test_api" {
	#Required
	api_id = oci_apigateway_api.test_api.id
}

Argument Reference

The following arguments are supported:

• api_id - (Required) The ocid of the API.

Attributes Reference

The following attributes are exported:

• compartment_id - The OCID of the compartment in which the resource is created.

• defined_tags - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

• display_name - A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information. Example: My new resource

• freeform_tags - Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

• id - The OCID of the resource.

• lifecycle_details - A message describing the current lifecycleState in more detail. For ACTIVE state it describes if the document has been validated and the possible values are:

  • ‘New’ for just updated API Specifications
  • ‘Validating’ for a document which is being validated.
  • ‘Valid’ the document has been validated without any errors or warnings
  • ‘Warning’ the document has been validated and contains warnings
  • ‘Error’ the document has been validated and contains errors
  • ‘Failed’ the document validation failed
  • ‘Canceled’ the document validation was canceled

  For other states it may provide more details like actionable information.

• locks - Locks associated with this resource.

  • message - A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
  • related_resource_id - The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
  • time_created - When the lock was created.
  • type - Type of the lock.

• specification_type - Type of API Specification file.

• state - The current state of the API.

• system_tags - System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}

• time_created - The time this resource was created. An RFC3339 formatted datetime string.

• time_updated - The time this resource was last updated. An RFC3339 formatted datetime string.

• validation_results - Status of each feature available from the API.

  • name - Name of the validation.
  • result - Result of the validation.