功能介紹
更新EIPPool。
調(diào)用方法
請參見如何調(diào)用API。
URI
PATCH /apis/crd.yangtse.cni/v1/namespaces/{namespace}/eippools/{name}
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
---|---|---|---|
name |
是 |
String |
name of the EIPPool |
namespace |
是 |
String |
object name and auth scope, such as for teams and projects |
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
---|---|---|---|
dryRun |
否 |
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 |
否 |
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. |
pretty |
否 |
String |
If 'true', then the output is pretty printed. |
請求參數(shù)
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用戶Token。 通過調(diào)用 IAM 服務獲取用戶Token接口獲取(響應消息頭中X-Subject-Token的值)。 |
Content-Type |
是 |
String |
目前支持三種類型的PATCH請求方法的操作,參考《使用JSON合并patch更新Deployment》。
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
---|---|---|---|
- |
是 |
Object |
Patch is provided to give a concrete name and type to the Kubernetes PATCH request body. |
響應參數(shù)
狀態(tài)碼: 200
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
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 |
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
spec |
Specification of the EIPPool. |
|
status |
Status of the EIPPool. |
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
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' |
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
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: http://kubernetes.io/docs/user-guide/identifiers#names |
uid |
String |
UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
amount |
Integer |
Amount is the amount of eips need to be create. 最小值:0 最大值:500 |
eipAttributes |
Attributes is the eip attributes which used to create eip. |
|
eips |
Array of strings |
EIPs used to generate EIP resources. |
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
alias |
String |
Alias of PublicIP |
bandwidth |
Bandwidth create attributes |
|
ipVersion |
Integer |
IP Version of PublicIP 枚舉值:
|
networkType |
String |
Network Type of PublicIP |
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
chargeMode |
String |
Bandwidth Charge Mode 枚舉值:
|
id |
String |
Bandwidth id, only useful for WHOLE bandwidth share type |
name |
String |
Bandwidth name, only useful for PER bandwidth share type 最小長度:1 最大長度:64 |
shareType |
String |
Bandwidth Share Type 枚舉值:
|
size |
Integer |
Bandwidth size 最小值:0 最大值:200000 |
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
associates |
eip associate infos. |
|
eips |
EIPs is a set of generated EIP resources. |
|
usage |
String |
Usage is usage of eip in this pool, e.g. 2/10. |
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
attachment |
Attachment is the eip attachment info. |
|
privateIP |
PrivateIP is private ip information |
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
freeTimestamp |
String |
Timestamp of NeutronPort be to FixedPreBound or FixedUnBound phase |
neutronPortName |
String |
NeutronPortName is NeutronPort name which associated. |
neutronPortNamespace |
String |
NeutronPortNamespace is NeutronPort namespace which associated. |
nodeName |
String |
NodeName is node name where the NeutronPort resides, must with phase Bound, PreBound or FixedBound. |
podName |
String |
Pod name |
podNamespace |
String |
Pod Namespace |
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
id |
String |
Port ID or EIP ID |
ipv4 |
String |
IPv4 is the IPv4 address for traffic from the eni. |
ipv6 |
String |
IPv6 is the IPv6 address for traffic from the eni. |
mac |
String |
MAC is the MAC address of the endpoint interface. |
status |
String |
Status of this IP |
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
alias |
String |
Alias of the PublicIP |
associateInstanceID |
String |
Associate instance id |
associateInstanceType |
String |
Associate instance type |
bandWidthChargeMode |
String |
Bandwidth charge mode of the PublicIP |
bandwidthShareType |
String |
Bandwidth share type of the PublicIP |
bandwidthSize |
Integer |
Bandwidth size of the PublicIP |
id |
String |
The ID of the PublicIP |
ipv4 |
String |
The ipv4 address of the PublicIP |
ipv6 |
String |
The ipv6 address of the PublicIP |
networkType |
String |
Network Type of PublicIP |
status |
String |
PublicIP status |
請求示例
更新EIPPool中的labels值為"some-key":"some-value"。
{
"metadata" : {
"labels" : {
"some-key" : "some-value"
}
}
}
響應示例
狀態(tài)碼: 200
OK
{
"apiVersion" : "crd.yangtse.cni/v1",
"kind" : "EIPPool",
"metadata" : {
"creationTimestamp" : "2022-09-07T01:22:50Z",
"finalizers" : [ "yangtse.io/eip-pool" ],
"generation" : 1,
"labels" : {
"some-key" : "some-value"
},
"name" : "eippool-test",
"namespace" : "namespace-test",
"resourceVersion" : "42396258",
"selfLink" : "/apis/crd.yangtse.cni/v1/namespaces/namespace-test/eippools/eippool-test",
"uid" : "e4dc5432-1d9b-4fcb-8840-ee445b6511ae"
},
"spec" : {
"amount" : 1,
"eipAttributes" : {
"bandwidth" : {
"chargeMode" : "bandwidth",
"name" : "eip-test",
"shareType" : "PER",
"size" : 5
},
"ipVersion" : 4,
"networkType" : "5_g-vm"
}
},
"status" : {
"eips" : [ {
"alias" : "eip-test",
"bandWidthChargeMode" : "bandwidth",
"bandwidthShareType" : "PER",
"bandwidthSize" : 5,
"id" : "034a0bae-81f7-46f4-b933-3273adc32b54",
"ipv4" : "100.85.221.2",
"networkType" : "5_g-vm",
"status" : "DOWN"
} ],
"usage" : "0/1"
}
}
狀態(tài)碼
狀態(tài)碼 |
描述 |
---|---|
200 |
OK |
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 |