DescribeVSwitchAttributes - 查询交换机的配置信息 - 边缘节点服务ENS

调用DescribeVSwitchAttributes接口查询指定交换机的配置信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ens:DescribeVSwitchAttributes	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
VSwitchId	string	是	交换机 ID。	vsw-5****

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	C0003****2A8
EnsRegionId	string	ENS 节点 ID。	cn-xian-unicom
NetworkId	string	网络 ID。	n-257gqcdfvx6n****
VSwitchName	string	交换机名称。	Test-switch
CidrBlock	string	网络的 IPv4 网段。	10.0.0.0/24
Status	string	交换机的状态，如下所示： Pending：配置中。 Available：可用。 Releasing：释放中。	Available
Description	string	交换机的描述。	This is my vswitch.
CreatedTime	string	创建时间，使用 UTC 时间格式，格式为 yyyy-MM-ddTHH:mm:ssZ。	2019-06-01T00:00:00Z
InstanceIds	array	实例 ID 列表。
InstanceId	string	实例 ID。	i-5****4evfn
NetworkInterfaceIds	array	弹性网卡 ID 列表。
NetworkInterfaceId	string	弹性网卡 ID。	eni-5****yfjm
LoadBalancerIds	array	负载均衡实例 ID 列表。
LoadBalancerId	string	负载均衡实例 ID。	lb-5****
NatGatewayIds	array	NAT 网关的 ID 列表。
NatGatewayId	string	NAT 网关的 ID。	nat-5****
HaVipIds	array	高可用 VIP 实例 ID 列表。
HaVipId	string	高可用 VIP 实例 ID。	havip-5****
VSwitchId	string	交换机 ID。	vsw-5****
AvailableIpAddressCount	long	交换机中可用的 IP 地址数量。	253

示例

正常返回示例

JSON格式

{
  "RequestId": "C0003****2A8",
  "EnsRegionId": "cn-xian-unicom",
  "NetworkId": "n-257gqcdfvx6n****",
  "VSwitchName": "Test-switch",
  "CidrBlock": "10.0.0.0/24",
  "Status": "Available",
  "Description": "This is my vswitch.",
  "CreatedTime": "2019-06-01T00:00:00Z",
  "InstanceIds": {
    "InstanceId": [
      "i-5****4evfn"
    ]
  },
  "NetworkInterfaceIds": {
    "NetworkInterfaceId": [
      "eni-5****yfjm"
    ]
  },
  "LoadBalancerIds": {
    "LoadBalancerId": [
      "lb-5****"
    ]
  },
  "NatGatewayIds": {
    "NatGatewayId": [
      "nat-5****"
    ]
  },
  "HaVipIds": {
    "HaVipId": [
      "havip-5****"
    ]
  },
  "VSwitchId": "vsw-5****",
  "AvailableIpAddressCount": 253
}

错误码

HTTP status code	错误码	错误信息	描述
400	ens.interface.error	Failed to call API.	接口调用发生异常。
400	InvalidVSwitchId.NotFound	Specified virtual switch does not exist.	指定的虚拟交换机 ID 不存在。
400	NoPermission	Permission denied.	没有足够的权限，请联系云账号管理员授予您相应权限。
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.	-

访问错误中心查看更多错误码。