Replacing the Specified Network¶

Function¶

Replace the specified Network.

Calling Method¶

For details, see Calling APIs.

URI¶

PUT /apis/yangtse/v2/namespaces/{namespace}/networks/{name}

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
name	Yes	String	Name of the Network.
namespace	Yes	String	Object name and auth scope, such as for teams and projects.

**Table 2** Query Parameters¶
Parameter	Mandatory	Type	Description
dryRun	No	String	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldManager	No	String	fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
fieldValidation	No	String	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the ServerSideFieldValidation feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the ServerSideFieldValidation feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the ServerSideFieldValidation feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
pretty	No	String	If 'true', then the output is pretty printed.

Request Parameters¶

**Table 3** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Content-Type	Yes	String	The type of the message body, with a default value of "application/JSON".

**Table 4** Request body parameters¶
Parameter	Mandatory	Type	Description
apiVersion	No	String	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind	No	String	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata	No	io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
spec	No	com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkSpec object	Specification of the desired behavior of network.
status	No	com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkStatus object	Most recently observed status of the network.

**Table 5** io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta¶
Parameter	Mandatory	Type	Description
annotations	No	Map<String,String>	Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
clusterName	No	String	The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
creationTimestamp	No	String	CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
deletionGracePeriodSeconds	No	Long	Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
deletionTimestamp	No	String	DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
enable	No	Boolean	Enable identifies whether the resource is available
finalizers	No	Array of strings	Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
generateName	No	String	GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
generation	No	Long	A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
labels	No	Map<String,String>	Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
managedFields	No	Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects	ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
name	No	String	Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
namespace	No	String	Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
ownerReferences	No	Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects	List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
resourceVersion	No	String	An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
selfLink	No	String	SelfLink is a URL representing this object. Populated by the system. Read-only. DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.
uid	No	String	UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

**Table 6** io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry¶
Parameter	Mandatory	Type	Description
apiVersion	No	String	APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
fieldsType	No	String	FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
fieldsV1	No	Object	FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
manager	No	String	Manager is an identifier of the workflow managing these fields.
operation	No	String	Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
time	No	String	Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'

**Table 7** io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference¶
Parameter	Mandatory	Type	Description
apiVersion	Yes	String	API version of the referent.
blockOwnerDeletion	No	Boolean	If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
controller	No	Boolean	If true, this reference points to the managing controller.
kind	Yes	String	Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
name	Yes	String	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
uid	Yes	String	UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

**Table 8** com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkSpec¶
Parameter	Mandatory	Type	Description
ipFamilies	No	Array of strings	IPFamilies of Network, can be "IPv4" or "IPv6".
networkType	No	String	Type of network, only support "underlay-neutron".
securityGroups	No	Array of strings	SecurityGroups of the network NOTE: 1. nil means not enable security group; 2. [""] means enable security group but deny all; 3. ["xxx,yyy"] means enable security group and allow with security group ids;
subnets	No	Array of com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetConf objects	Describes the subnets of the network.

**Table 9** com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetConf¶
Parameter	Mandatory	Type	Description
subnetID	No	String	SubnetID subnetV4ID of the subnet.

**Table 10** com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkStatus¶
Parameter	Mandatory	Type	Description
conditions	No	Array of io.k8s.apimachinery.pkg.apis.meta.v1.Condition objects	Conditions describe the current conditions of the Network.
status	No	String	Status of network, can be "Ready" or "Failed" or "IPInsufficient"
subnetAttrs	No	Array of com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetAttr objects	SubnetAttrs describe the current subnet information of the Network.

**Table 11** io.k8s.apimachinery.pkg.apis.meta.v1.Condition¶
Parameter	Mandatory	Type	Description
lastTransitionTime	Yes	String	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message	Yes	String	message is a human readable message indicating details about the transition. This may be an empty string.
observedGeneration	No	Long	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
reason	Yes	String	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
status	Yes	String	status of the condition, one of True, False, Unknown.
type	Yes	String	type of condition in CamelCase or in foo.example.com/CamelCase.

**Table 12** com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetAttr¶
Parameter	Mandatory	Type
networkID	No	String
subnetV4ID	No	String
subnetV6ID	No	String

Response Parameters¶

Status code: 200

**Table 13** Response body parameters¶
Parameter	Type	Description
apiVersion	String	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind	String	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata	io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
spec	com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkSpec object	Specification of the desired behavior of network.
status	com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkStatus object	Most recently observed status of the network.

**Table 14** io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta¶
Parameter	Type	Description
annotations	Map<String,String>	Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
clusterName	String	The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
creationTimestamp	String	CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
deletionGracePeriodSeconds	Long	Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
deletionTimestamp	String	DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
enable	Boolean	Enable identifies whether the resource is available
finalizers	Array of strings	Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
generateName	String	GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
generation	Long	A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
labels	Map<String,String>	Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
managedFields	Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects	ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
name	String	Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
namespace	String	Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
ownerReferences	Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects	List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
resourceVersion	String	An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
selfLink	String	SelfLink is a URL representing this object. Populated by the system. Read-only. DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.
uid	String	UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

**Table 15** io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry¶
Parameter	Type	Description
apiVersion	String	APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
fieldsType	String	FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
fieldsV1	Object	FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
manager	String	Manager is an identifier of the workflow managing these fields.
operation	String	Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
time	String	Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'

**Table 16** io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference¶
Parameter	Type	Description
apiVersion	String	API version of the referent.
blockOwnerDeletion	Boolean	If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
controller	Boolean	If true, this reference points to the managing controller.
kind	String	Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
name	String	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
uid	String	UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

**Table 17** com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkSpec¶
Parameter	Type	Description
ipFamilies	Array of strings	IPFamilies of Network, can be "IPv4" or "IPv6".
networkType	String	Type of network, only support "underlay-neutron".
securityGroups	Array of strings	SecurityGroups of the network NOTE: 1. nil means not enable security group; 2. [""] means enable security group but deny all; 3. ["xxx,yyy"] means enable security group and allow with security group ids;
subnets	Array of com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetConf objects	Describes the subnets of the network

**Table 18** com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetConf¶
Parameter	Type	Description
subnetID	String	SubnetID subnetV4ID of the subnet

**Table 19** com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkStatus¶
Parameter	Type	Description
conditions	Array of io.k8s.apimachinery.pkg.apis.meta.v1.Condition objects	Conditions describe the current conditions of the Network.
status	String	Status of network, can be "Ready" or "Failed" or "IPInsufficient"
subnetAttrs	Array of com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetAttr objects	SubnetAttrs describe the current subnet information of the Network

**Table 20** io.k8s.apimachinery.pkg.apis.meta.v1.Condition¶
Parameter	Type	Description
lastTransitionTime	String	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message	String	message is a human readable message indicating details about the transition. This may be an empty string.
observedGeneration	Long	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
reason	String	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
status	String	status of the condition, one of True, False, Unknown.
type	String	type of condition in CamelCase or in foo.example.com/CamelCase.

**Table 21** com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetAttr¶
Parameter	Type	Description
networkID	String
subnetV4ID	String
subnetV6ID	String

Status code: 201

**Table 22** Response body parameters¶
Parameter	Type	Description
apiVersion	String	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind	String	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata	io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
spec	com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkSpec object	Specification of the desired behavior of network.
status	com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkStatus object	Most recently observed status of the network.

**Table 23** io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta¶
Parameter	Type	Description
annotations	Map<String,String>	Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
clusterName	String	The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
creationTimestamp	String	CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
deletionGracePeriodSeconds	Long	Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
deletionTimestamp	String	DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
enable	Boolean	Enable identifies whether the resource is available
finalizers	Array of strings	Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
generateName	String	GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
generation	Long	A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
labels	Map<String,String>	Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
managedFields	Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects	ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
name	String	Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
namespace	String	Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
ownerReferences	Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects	List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
resourceVersion	String	An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
selfLink	String	SelfLink is a URL representing this object. Populated by the system. Read-only. DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.
uid	String	UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

**Table 24** io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry¶
Parameter	Type	Description
apiVersion	String	APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
fieldsType	String	FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
fieldsV1	Object	FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
manager	String	Manager is an identifier of the workflow managing these fields.
operation	String	Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
time	String	Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'

**Table 25** io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference¶
Parameter	Type	Description
apiVersion	String	API version of the referent.
blockOwnerDeletion	Boolean	If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
controller	Boolean	If true, this reference points to the managing controller.
kind	String	Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
name	String	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
uid	String	UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

**Table 26** com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkSpec¶
Parameter	Type	Description
ipFamilies	Array of strings	IPFamilies of Network, can be "IPv4" or "IPv6"
networkType	String	Type of network, only support "underlay-neutron"
securityGroups	Array of strings	SecurityGroups of the network. NOTE: 1. nil means not enable security group; 2. [""] means enable security group but deny all; 3. ["xxx,yyy"] means enable security group and allow with security group ids;
subnets	Array of com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetConf objects	Describes the subnets of the network.

**Table 27** com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetConf¶
Parameter	Type	Description
subnetID	String	SubnetID subnetV4ID of the subnet

**Table 28** com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkStatus¶
Parameter	Type	Description
conditions	Array of io.k8s.apimachinery.pkg.apis.meta.v1.Condition objects	Conditions describe the current conditions of the Network.
status	String	Status of network, can be "Ready" or "Failed" or "IPInsufficient".
subnetAttrs	Array of com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetAttr objects	SubnetAttrs describe the current subnet information of the Network.

**Table 29** io.k8s.apimachinery.pkg.apis.meta.v1.Condition¶
Parameter	Type	Description
lastTransitionTime	String	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message	String	message is a human readable message indicating details about the transition. This may be an empty string.
observedGeneration	Long	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
reason	String	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
status	String	status of the condition, one of True, False, Unknown.
type	String	type of condition in CamelCase or in foo.example.com/CamelCase.

**Table 30** com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetAttr¶
Parameter	Type	Description
networkID	String
subnetV4ID	String
subnetV6ID	String

Example Requests¶

{
  "apiVersion" : "yangtse/v2",
  "kind" : "Network",
  "metadata" : {
    "annotations" : {
      "yangtse.io/domain-id" : "08a*************************ee60",
      "yangtse.io/project-id" : "08a2*************************c03",
      "yangtse.io/warm-pool-recycle-interval" : "1",
      "yangtse.io/warm-pool-size" : "10"
    },
    "creationTimestamp" : "2024-03-25T09:27:52Z",
    "finalizers" : [ "yangtse.io/network-cleanup" ],
    "name" : "test-api",
    "namespace" : "test-api",
    "resourceVersion" : "17365331",
    "uid" : "70c20697-a233-4405-b512-ebec1d3c58d0"
  },
  "spec" : {
    "networkType" : "underlay_neutron",
    "securityGroups" : [ "4120c2f9-3a1d-453e-9b64-f51b92861e26" ],
    "subnets" : [ {
      "subnetID" : "2eb62e19-cf1a-4741-90cc-90fb127b20ab"
    } ]
  },
  "status" : {
    "conditions" : [ {
      "lastTransitionTime" : "2024-03-25T09:27:53Z",
      "message" : "",
      "reason" : "",
      "status" : "True",
      "type" : "NetworkSynced"
    }, {
      "lastTransitionTime" : "2024-08-12T15:40:03Z",
      "message" : "",
      "reason" : "",
      "status" : "True",
      "type" : "NetworkExternalDependenciesSynced"
    } ],
    "status" : "Ready",
    "subnetAttrs" : [ {
      "networkID" : "377b6228-d2a7-47ab-bdb0-f7fc59802198",
      "subnetV4ID" : "2eb62e19-cf1a-4741-90cc-90fb127b20ab"
    } ]
  }
}

Example Responses¶

Status code: 200

{
  "apiVersion" : "yangtse/v2",
  "kind" : "Network",
  "metadata" : {
    "annotations" : {
      "yangtse.io/domain-id" : "08a*************************ee60",
      "yangtse.io/project-id" : "08a2*************************c03",
      "yangtse.io/warm-pool-recycle-interval" : "1",
      "yangtse.io/warm-pool-size" : "10"
    },
    "creationTimestamp" : "2024-03-25T09:27:52Z",
    "finalizers" : [ "yangtse.io/network-cleanup" ],
    "name" : "test-api",
    "namespace" : "test-api",
    "resourceVersion" : "17365331",
    "uid" : "70c20697-a233-4405-b512-ebec1d3c58d0"
  },
  "spec" : {
    "networkType" : "underlay_neutron",
    "securityGroups" : [ "4120c2f9-3a1d-453e-9b64-f51b92861e26" ],
    "subnets" : [ {
      "subnetID" : "2eb62e19-cf1a-4741-90cc-90fb127b20ab"
    } ]
  },
  "status" : {
    "conditions" : [ {
      "lastTransitionTime" : "2024-03-25T09:27:53Z",
      "message" : "",
      "reason" : "",
      "status" : "True",
      "type" : "NetworkSynced"
    }, {
      "lastTransitionTime" : "2024-08-12T15:40:03Z",
      "message" : "",
      "reason" : "",
      "status" : "True",
      "type" : "NetworkExternalDependenciesSynced"
    } ],
    "status" : "Ready",
    "subnetAttrs" : [ {
      "networkID" : "377b6228-d2a7-47ab-bdb0-f7fc59802198",
      "subnetV4ID" : "2eb62e19-cf1a-4741-90cc-90fb127b20ab"
    } ]
  }
}

Status Codes¶

Status Code	Description
200	OK
201	Created
400	BadRequest
401	Unauthorized
403	Forbidden
404	NotFound
405	MethodNotAllowed
406	NotAcceptable
409	Conflict
415	UnsupportedMediaType
422	Invalid
429	TooManyRequests
500	InternalError
503	ServiceUnavailable
504	ServerTimeout

last updated: 2024-12-10 14:13 UTC - commit: aa8ce666bd5859b546f363c3fb8079ee8739accc