华为云计算 云知识 查询指定的EIPPoolreadCrdYangtseCniV1NamespacedEIPPoolStatus
查询指定的EIPPoolreadCrdYangtseCniV1NamespacedEIPPoolStatus

 

功能介绍

查询指定的EIPPool的详细信息。

调用方法

请参见如何调用API

URI

GET /apis/crd.yangtse.cni/v1/namespaces/{namespace}/eippools/{name}/status

表1 路径参数

参数

是否必选

参数类型

描述

name

String

name of the EIPPool

namespace

String

object name and auth scope, such as for teams and projects

表2 Query参数

参数

是否必选

参数类型

描述

resourceVersion

String

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

pretty

String

If 'true', then the output is pretty printed.

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

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

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

spec object

Specification of the EIPPool.

status

status object

Status of the EIPPool.

表5 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

参数

参数类型

描述

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: http://kubernetes.io/docs/user-guide/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

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: http://kubernetes.io/docs/user-guide/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: http://kubernetes.io/docs/user-guide/identifiers#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: http://kubernetes.io/docs/user-guide/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: http://kubernetes.io/docs/user-guide/identifiers#uids

表6 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

参数

参数类型

描述

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'

表7 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

参数

参数类型

描述

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

表8 spec

参数

参数类型

描述

amount

Integer

Amount is the amount of eips need to be create.

最小值:0

最大值:500

eipAttributes

cni.yangtse.crd.v1.EIPAttributes object

Attributes is the eip attributes which used to create eip.

eips

Array of strings

EIPs used to generate EIP resources.

表9 cni.yangtse.crd.v1.EIPAttributes

参数

参数类型

描述

alias

String

Alias of PublicIP

bandwidth

cni.yangtse.crd.v1.EIPBandwidth object

Bandwidth create attributes

ipVersion

Integer

IP Version of PublicIP

枚举值:

  • 4

  • 6

networkType

String

Network Type of PublicIP

表10 cni.yangtse.crd.v1.EIPBandwidth

参数

参数类型

描述

chargeMode

String

Bandwidth Charge Mode

枚举值:

  • bandwidth

  • traffic

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

枚举值:

  • PER

  • WHOLE

size

Integer

Bandwidth size

最小值:0

最大值:200000

表11 status

参数

参数类型

描述

associates

Map<String,cni.yangtse.crd.v1.EIPAssociate>

eip associate infos.

eips

Array of eips objects

EIPs is a set of generated EIP resources.

usage

String

Usage is usage of eip in this pool, e.g. 2/10.

表12 cni.yangtse.crd.v1.EIPAssociate

参数

参数类型

描述

attachment

attachment object

Attachment is the eip attachment info.

privateIP

privateIP object

PrivateIP is private ip information

表13 attachment

参数

参数类型

描述

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

表14 privateIP

参数

参数类型

描述

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

表15 eips

参数

参数类型

描述

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

请求示例

响应示例

状态码: 200

OK

{
  "apiVersion" : "crd.yangtse.cni/v1",
  "kind" : "EIPPool",
  "metadata" : {
    "creationTimestamp" : "2022-09-07T01:22:50Z",
    "finalizers" : [ "yangtse.io/eip-pool" ],
    "generation" : 1,
    "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"
  }
}

状态码

状态码

描述

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

 

上一篇:Logwire智慧物流-机构数据主档 下一篇:2020华为软件精英挑战赛热身赛程知识竞答