Marketplace
BrowsePublish
Marketplace
crossplane-contrib/provider-tencentcloud@v0.8.3
Api
apigateway.tencentcloud.crossplane.io
Api
crossplane-contrib/provider-tencentcloud@v0.8.3apigateway.tencentcloud.crossplane.io

Api is the Schema for the Apis API. Use this resource to create API of API gateway.

Type

CRD

Group

apigateway.tencentcloud.crossplane.io

Version

v1alpha1

apiVersion: apigateway.tencentcloud.crossplane.io/v1alpha1

kind: Api

API Documentation
apiVersion
string
kind
string
metadata
object
spec
object
object

ApiSpec defines the desired state of Api

forProvider
requiredobject
requiredobject

No description provided.

apiDesc
string
apiName
string
apiType
string
authType
string
array

Constant parameter. Constant parameter.

desc
string
name
string
position
string
eiamAppId
string
enableCors
boolean
array

API bound microservice list. API bound microservice list.

array

OAuth configuration. Effective when AuthType is OAUTH. OAuth configuration. Effective when AuthType is OAUTH.

owner
string
preLimit
number
protocol
string
array

Frontend request parameters. Frontend request parameters.

desc
string
name
string
position
string
required
boolean
type
string
array

Custom error code configuration. Must keep at least one after set. Custom error code configuration. Must keep at least one after set.

code
number
desc
string
msg
string
array

API backend COS configuration. If ServiceType is COS, then this parameter must be passed.Note: This field may return null, indicating that a valid value cannot be obtained. API backend COS configuration. If ServiceType is COS, then this parameter must be passed.Note: This field may return null, indicating that a valid value cannot be obtained.

serviceId
string
object

Reference to a Service to populate serviceId.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Service to populate serviceId.

policy
object
object

Policies for selection.

resolve
string
array

The backend service parameters of the API. The backend service parameters of the API.

array

Health check configuration for microservices. Health check configuration for microservices.

array

Load balancing configuration for microservices. Load balancing configuration for microservices.

array

Target type backend resource information. (Internal testing stage). Target type backend resource information. (Internal testing stage).

dockerIp
string
hostIp
string
vmIp
string
vmPort
number
vpcId
string
array

Target health check configuration. (Internal testing stage). Target health check configuration. (Internal testing stage).

testLimit
number
userType
string
object

THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.

apiDesc
string
apiName
string
apiType
string
authType
string
array

Constant parameter. Constant parameter.

desc
string
name
string
position
string
eiamAppId
string
enableCors
boolean
array

API bound microservice list. API bound microservice list.

array

OAuth configuration. Effective when AuthType is OAUTH. OAuth configuration. Effective when AuthType is OAUTH.

owner
string
preLimit
number
protocol
string
array

Frontend request parameters. Frontend request parameters.

desc
string
name
string
position
string
required
boolean
type
string
array

Custom error code configuration. Must keep at least one after set. Custom error code configuration. Must keep at least one after set.

code
number
desc
string
msg
string
array

API backend COS configuration. If ServiceType is COS, then this parameter must be passed.Note: This field may return null, indicating that a valid value cannot be obtained. API backend COS configuration. If ServiceType is COS, then this parameter must be passed.Note: This field may return null, indicating that a valid value cannot be obtained.

serviceId
string
object

Reference to a Service to populate serviceId.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Service to populate serviceId.

policy
object
object

Policies for selection.

resolve
string
array

The backend service parameters of the API. The backend service parameters of the API.

array

Health check configuration for microservices. Health check configuration for microservices.

array

Load balancing configuration for microservices. Load balancing configuration for microservices.

array

Target type backend resource information. (Internal testing stage). Target type backend resource information. (Internal testing stage).

dockerIp
string
hostIp
string
vmIp
string
vmPort
number
vpcId
string
array

Target health check configuration. (Internal testing stage). Target health check configuration. (Internal testing stage).

testLimit
number
userType
string
array

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

configRef
object
object

SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
metadata
object
object

Metadata is the metadata for connection secret.

labels
object
type
string
name
requiredstring
object

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.

name
requiredstring
namespace
requiredstring
status
object
object

ApiStatus defines the observed state of Api.

object

No description provided.

apiDesc
string
apiName
string
apiType
string
authType
string
array

Constant parameter. Constant parameter.

desc
string
name
string
position
string
eiamAppId
string
enableCors
boolean
id
string
array

API bound microservice list. API bound microservice list.

array

OAuth configuration. Effective when AuthType is OAUTH. OAuth configuration. Effective when AuthType is OAUTH.

owner
string
preLimit
number
protocol
string
array

Frontend request parameters. Frontend request parameters.

desc
string
name
string
position
string
required
boolean
type
string
array

Custom error code configuration. Must keep at least one after set. Custom error code configuration. Must keep at least one after set.

code
number
desc
string
msg
string
array

API backend COS configuration. If ServiceType is COS, then this parameter must be passed.Note: This field may return null, indicating that a valid value cannot be obtained. API backend COS configuration. If ServiceType is COS, then this parameter must be passed.Note: This field may return null, indicating that a valid value cannot be obtained.

serviceId
string
array

The backend service parameters of the API. The backend service parameters of the API.

array

Health check configuration for microservices. Health check configuration for microservices.

array

Load balancing configuration for microservices. Load balancing configuration for microservices.

array

Target type backend resource information. (Internal testing stage). Target type backend resource information. (Internal testing stage).

dockerIp
string
hostIp
string
vmIp
string
vmPort
number
vpcId
string
array

Target health check configuration. (Internal testing stage). Target health check configuration. (Internal testing stage).

testLimit
number
userType
string
array

Conditions of the resource.

lastTransitionTime
requiredstring
message
string
reason
requiredstring
status
requiredstring
type
requiredstring
Marketplace

Discover the building blocks for your internal cloud platform.

© 2024 Upbound, Inc.

SolutionsProvidersConfigurations
LearnDocumentationTry for Free
MorePrivacy PolicyTerms & Conditions
Marketplace

© 2024 Upbound, Inc.

Marketplace

Discover the building blocksfor your internal cloud platform.