oci.ApiGateway.getApi
Explore with Pulumi AI
This data source provides details about a specific Api resource in Oracle Cloud Infrastructure API Gateway service.
Gets an API by identifier.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testApi = Oci.ApiGateway.GetApi.Invoke(new()
{
ApiId = oci_apigateway_api.Test_api.Id,
});
});
package main
import (
"github.com/pulumi/pulumi-oci/sdk/go/oci/ApiGateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ApiGateway.GetApi(ctx, &apigateway.GetApiArgs{
ApiId: oci_apigateway_api.Test_api.Id,
}, nil)
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ApiGateway.ApiGatewayFunctions;
import com.pulumi.oci.ApiGateway.inputs.GetApiArgs;
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 testApi = ApiGatewayFunctions.getApi(GetApiArgs.builder()
.apiId(oci_apigateway_api.test_api().id())
.build());
}
}
import pulumi
import pulumi_oci as oci
test_api = oci.ApiGateway.get_api(api_id=oci_apigateway_api["test_api"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testApi = oci.ApiGateway.getApi({
apiId: oci_apigateway_api.test_api.id,
});
variables:
testApi:
fn::invoke:
Function: oci:ApiGateway:getApi
Arguments:
apiId: ${oci_apigateway_api.test_api.id}
Using getApi
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getApi(args: GetApiArgs, opts?: InvokeOptions): Promise<GetApiResult>
function getApiOutput(args: GetApiOutputArgs, opts?: InvokeOptions): Output<GetApiResult>
def get_api(api_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetApiResult
def get_api_output(api_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetApiResult]
func GetApi(ctx *Context, args *GetApiArgs, opts ...InvokeOption) (*GetApiResult, error)
func GetApiOutput(ctx *Context, args *GetApiOutputArgs, opts ...InvokeOption) GetApiResultOutput
> Note: This function is named GetApi
in the Go SDK.
public static class GetApi
{
public static Task<GetApiResult> InvokeAsync(GetApiArgs args, InvokeOptions? opts = null)
public static Output<GetApiResult> Invoke(GetApiInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetApiResult> getApi(GetApiArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:ApiGateway/getApi:getApi
arguments:
# arguments dictionary
The following arguments are supported:
- Api
Id string The ocid of the API.
- Api
Id string The ocid of the API.
- api
Id String The ocid of the API.
- api
Id string The ocid of the API.
- api_
id str The ocid of the API.
- api
Id String The ocid of the API.
getApi Result
The following output properties are available:
- Api
Id string - Compartment
Id string The OCID of the compartment in which the resource is created.
- Content string
- Dictionary<string, object>
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 string A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example:
My new resource
- Dictionary<string, object>
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 string
The OCID of the resource.
- Lifecycle
Details string 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
- Specification
Type string Type of API Specification file.
- State string
The current state of the API.
- Time
Created string The time this resource was created. An RFC3339 formatted datetime string.
- Time
Updated string The time this resource was last updated. An RFC3339 formatted datetime string.
- Validation
Results List<GetApi Validation Result> Status of each feature available from the API.
- Api
Id string - Compartment
Id string The OCID of the compartment in which the resource is created.
- Content string
- map[string]interface{}
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 string A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example:
My new resource
- map[string]interface{}
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 string
The OCID of the resource.
- Lifecycle
Details string 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
- Specification
Type string Type of API Specification file.
- State string
The current state of the API.
- Time
Created string The time this resource was created. An RFC3339 formatted datetime string.
- Time
Updated string The time this resource was last updated. An RFC3339 formatted datetime string.
- Validation
Results []GetApi Validation Result Status of each feature available from the API.
- api
Id String - compartment
Id String The OCID of the compartment in which the resource is created.
- content String
- Map<String,Object>
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 String A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example:
My new resource
- Map<String,Object>
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 String
The OCID of the resource.
- lifecycle
Details String 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
- specification
Type String Type of API Specification file.
- state String
The current state of the API.
- time
Created String The time this resource was created. An RFC3339 formatted datetime string.
- time
Updated String The time this resource was last updated. An RFC3339 formatted datetime string.
- validation
Results List<GetApi Validation Result> Status of each feature available from the API.
- api
Id string - compartment
Id string The OCID of the compartment in which the resource is created.
- content string
- {[key: string]: any}
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 string A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example:
My new resource
- {[key: string]: any}
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 string
The OCID of the resource.
- lifecycle
Details string 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
- specification
Type string Type of API Specification file.
- state string
The current state of the API.
- time
Created string The time this resource was created. An RFC3339 formatted datetime string.
- time
Updated string The time this resource was last updated. An RFC3339 formatted datetime string.
- validation
Results GetApi Validation Result[] Status of each feature available from the API.
- api_
id str - compartment_
id str The OCID of the compartment in which the resource is created.
- content str
- Mapping[str, Any]
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 str A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example:
My new resource
- Mapping[str, Any]
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 str
The OCID of the resource.
- lifecycle_
details str 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
- specification_
type str Type of API Specification file.
- state str
The current state of the API.
- time_
created str The time this resource was created. An RFC3339 formatted datetime string.
- time_
updated str The time this resource was last updated. An RFC3339 formatted datetime string.
- validation_
results GetApi Validation Result] Status of each feature available from the API.
- api
Id String - compartment
Id String The OCID of the compartment in which the resource is created.
- content String
- Map<Any>
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 String A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example:
My new resource
- Map<Any>
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 String
The OCID of the resource.
- lifecycle
Details String 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
- specification
Type String Type of API Specification file.
- state String
The current state of the API.
- time
Created String The time this resource was created. An RFC3339 formatted datetime string.
- time
Updated String The time this resource was last updated. An RFC3339 formatted datetime string.
- validation
Results List<Property Map> Status of each feature available from the API.
Supporting Types
GetApiValidationResult
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
oci
Terraform Provider.