Connector [connectors.alauda.io/v1alpha1]
- Description
- Connector is the Schema for the connectors API
- Type
object
Specification
.spec
- Description
- ConnectorSpec defines the desired state of Connector
- Type
object
.spec.auth
- Description
- Auth represents authenticate data of current connector
- Type
object
.spec.auth.params
- Description
- Params information required for authentication
- Type
array
.spec.auth.params[]
- Description
- Param declares an ParamValues to use for the parameter called name.
- Type
object- Required
namevalue
.spec.auth.secretRef
- Description
- SecretRef secret reference when doing authentication
- Type
object
.spec.params
- Description
- Params information required for spec
- Type
array
.spec.params[]
- Description
- Param declares an ParamValues to use for the parameter called name.
- Type
object- Required
namevalue
.status
- Description
- ConnectorStatus defines the observed state of Connector
- Type
object
.status.annotations
- Description
- Annotations is additional Status fields for the Resource to save some additional State as well as convey more information to the user. This is roughly akin to Annotations on any k8s resource, just the reconciler conveying richer information outwards.
- Type
object
.status.api
- Description
- API contains the status information for the connector's api
- Type
object
.status.conditions
- Description
- Conditions the latest available observations of a resource's current state.
- Type
array
.status.conditions[]
- Description
- Condition defines a readiness condition for a Knative resource. See: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#typical-status-properties
- Type
object- Required
statustype
.status.proxy
- Description
- Proxy contains the status information for the connector's proxy
- Type
object
.status.proxy.httpAddress
- Description
- HTTPAddress provides the addressable HTTP endpoint for the connector proxy.
- Type
object
API Endpoints
The following API endpoints are available:
/apis/connectors.alauda.io/v1alpha1/namespaces/{namespace}/connectorsDELETE: delete collection of ConnectorGET: list objects of kind ConnectorPOST: create a new Connector
/apis/connectors.alauda.io/v1alpha1/namespaces/{namespace}/connectors/{name}DELETE: delete the specified ConnectorGET: read the specified ConnectorPATCH: partially update the specified ConnectorPUT: replace the specified Connector
/apis/connectors.alauda.io/v1alpha1/namespaces/{namespace}/connectors/{name}/statusGET: read status of the specified ConnectorPATCH: partially update status of the specified ConnectorPUT: replace status of the specified Connector
/apis/connectors.alauda.io/v1alpha1/namespaces/{namespace}/connectors
- HTTP method
DELETE- Description
- delete collection of Connector
- HTTP responses
- HTTP method
GET- Description
- list objects of kind Connector
- HTTP responses
- HTTP method
POST- Description
- create a new Connector
- Query parameters
- Body parameters
- HTTP responses
/apis/connectors.alauda.io/v1alpha1/namespaces/{namespace}/connectors/{name}
- HTTP method
DELETE- Description
- delete the specified Connector
- Query parameters
- HTTP responses
- HTTP method
GET- Description
- read the specified Connector
- HTTP responses
- HTTP method
PATCH- Description
- partially update the specified Connector
- Query parameters
- HTTP responses
- HTTP method
PUT- Description
- replace the specified Connector
- Query parameters
- Body parameters
- HTTP responses
/apis/connectors.alauda.io/v1alpha1/namespaces/{namespace}/connectors/{name}/status
- HTTP method
GET- Description
- read status of the specified Connector
- HTTP responses
- HTTP method
PATCH- Description
- partially update status of the specified Connector
- Query parameters
- HTTP responses
- HTTP method
PUT- Description
- replace status of the specified Connector
- Query parameters
- Body parameters
- HTTP responses