文档首页/ 云容器实例 CCI/ API参考/ API说明/ Network/ 查询指定Namespace下的Networks - listNamespacedNetworks
更新时间:2026-02-05 GMT+08:00
分享

查询指定Namespace下的Networks - listNamespacedNetworks

功能介绍

该API用于查询指定Namespace下所有Network的详细信息。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /apis/yangtse/v2/namespaces/{namespace}/networks

表1 路径参数

参数

是否必选

参数类型

描述

namespace

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值,获取方式请参见认证鉴权

响应参数

状态码:200

表3 响应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

items

Array of com.paas-core.yangtse.pkg.apis.yangtse.v2.Network objects

Network is a logical network defined in yangtse

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.ListMeta object

ListMeta describes metadata that synthetic resources must have, including

lists and various status objects. A resource may have only one of {ObjectMeta,

ListMeta}.

表4 com.paas-core.yangtse.pkg.apis.yangtse.v2.Network

参数

参数类型

描述

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_v2 object

ObjectMeta is metadata that all persisted resources must have, which

includes all objects users must create.

spec

com.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkSpec object

Specification of the desired behavior of network.

status

com.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkStatus object

Most recently observed status of the network.

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

参数

参数类型

描述

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

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 return a 409.

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

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_v2 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

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

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

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

参数

参数类型

描述

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. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion

for how the garbage collector interacts with this field and enforces the

foreground deletion. 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

表7 com.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkSpec

参数

参数类型

描述

defaultNetwork

Boolean

Identifies whether the network is the default network

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.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetConf objects

Describes the subnets of the network

表8 com.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetConf

参数

参数类型

描述

subnetID

String

SubnetID subnetV4ID of the subnet

表9 com.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkStatus

参数

参数类型

描述

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.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetAttr objects

SubnetAttrs describe the current subnet information of the Network

表10 io.k8s.apimachinery.pkg.apis.meta.v1.Condition

参数

参数类型

描述

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.

表11 com.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetAttr

参数

参数类型

描述

networkID

String

subnetV4ID

String

subnetV6ID

String

表12 io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta

参数

参数类型

描述

continue

String

continue may be set if the user set a limit on the number of

items returned, and indicates that the server has more data available. The

value is opaque and may be used to issue another request to the endpoint

that served this list to retrieve the next set of available objects. Continuing

a consistent list may not be possible if the server configuration has changed

or more than a few minutes have passed. The resourceVersion field returned

when using this continue value will be identical to the value in the first

response, unless you have received this token from an error message.

remainingItemCount

Long

remainingItemCount is the number of subsequent items in the list

which are not included in this list response. If the list request contained

label or field selectors, then the number of remaining items is unknown

and the field will be left unset and omitted during serialization. If the

list is complete (either because it is not chunking or because this is the

last chunk), then there are no more remaining items and this field will

be left unset and omitted during serialization. Servers older than v1.15

do not set this field. The intended use of the remainingItemCount is estimating

the size of a collection. Clients should not rely on the remainingItemCount

to be set or to be exact.

resourceVersion

String

String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

selfLink

String

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

请求示例

响应示例

状态码:200

OK

{
  "apiVersion" : "v1",
  "items" : [ {
    "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"
      } ]
    }
  } ],
  "kind" : "List",
  "metadata" : {
    "resourceVersion" : ""
  }
}

状态码

状态码

描述

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

相关文档