华为云计算 云知识 查询Network状态readNetworkingCciIoV1beta1NamespacedNetworkStatus
查询Network状态readNetworkingCciIoV1beta1NamespacedNetworkStatus

 

接口说明

查询一个指定Network对象的状态。

URL
GET  https://cci.cn-north-4.myhuaweicloud.com/apis/networking.cci.io/v1beta1/namespaces/{namespace}/networks/{name}/status 
请求参数
名称 类型 IN 必选 描述
X-Auth-Token
 
string header

用户Token。

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

name
 
string path

name of the Network

namespace
 
string path

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

pretty
 
string query

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

返回参数
返回码: 200

OK

名称 类型 必选 描述
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
 
io.k8s.api.cci.v1beta1.NetworkSpec object

Spec defines the attributes on a network

status
 
io.k8s.api.cci.v1beta1.NetworkStatus object

Status describes the network status

200 metadata
名称 类型 必选 描述
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

200 metadata.managedFields
名称 类型 必选 描述
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
 
io.k8s.apimachinery.pkg.apis.meta.v1.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'

200 metadata.ownerReferences
名称 类型 必选 描述
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

200 spec
名称 类型 必选 描述
attachedVPC
 
string

ID of the VPC to attach

availableZone
 
string

available zone

cidr
 
string

The CIDR of the network

networkID
 
string

network ID

networkType
 
string

network type like 'overlay_l2'

subnetID
 
string

Subnet ID

subnets
 
Array of io.k8s.api.cci.v1beta1.NetworkSubnet objects

Subnets

200 spec.subnets
名称 类型 必选 描述
cidr
 
string

The CIDR of the network

networkID
 
string

NetworkID describes the subnet network id

subnetID
 
string

SubnetID describes the subnet id

200 status
名称 类型 必选 描述
message
 
string

Message describes why network is in current state

state
 
string

State describes the network state

返回码: 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

返回示例
返回码:200

OK

示例 1
 
{
"apiVersion": "networking.cci.io/v1beta1",
"kind": "Network",
"metadata": {
"annotations": {
"network.alpha.kubernetes.io/default-security-group": "security-group-id",
"network.alpha.kubernetes.io/domain-id": "domain-id",
"network.alpha.kubernetes.io/project-id": "project-id",
"network.alpha.kubernetes.io/type": "underlay_neutron"
},
"creationTimestamp": "2018-08-21T02:35:59Z",
"name": "test-network",
"namespace": "test-ns",
"resourceVersion": "2025736",
"selfLink": "/apis/networking.cci.io/v1beta1/namespaces/test-ns/networks/test-network",
"uid": "f03452ac-a4ea-11e8-8500-c81fbe371a17"
},
"spec": {
"attachedVPC": "vpc-id",
"availableZone": "cn-north-4a",
"cidr": "192.168.0.0/24",
"networkID": "network-id",
"networkType": "underlay_neutron",
"subnetID": "subnet-id"
},
"status": {
"state": "Active"
}
}
错误码
请参考 错误码说明

 

上一篇:路由器删除接口NeutronRemoveRouterInterface 下一篇:跨地域、跨云数据共享交换