查詢可組網(wǎng)的信息,內(nèi)網(wǎng)按vswitch進(jìn)行組網(wǎng)。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別:是指每個(gè)操作的訪問級(jí)別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對(duì)于必選的資源類型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
vpc:DescribeVSwitches | list | *VSwitch acs:vpc:{#regionId}:{#accountId}:vswitch/* |
| 無 |
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
VpcId | string | 否 | 要查詢的交換機(jī)所屬 VPC 的 ID。 說明
RegionId 和 VpcId 參數(shù)至少輸入一個(gè)。
| vpc-25cdvfeq58pl**** |
VSwitchId | string | 否 | 要查詢的交換機(jī)的 ID。 | vsw-23dscddcffvf3**** |
ZoneId | string | 否 | 交換機(jī)所屬可用區(qū)的 ID。您可以通過調(diào)用 DescribeZones 接口獲取可用區(qū) ID。 | cn-hangzhou-d |
RegionId | string | 否 | 交換機(jī)所屬地域的 ID。您可以通過調(diào)用 DescribeRegions 接口獲取地域 ID。 說明
RegionId 和 VpcId 參數(shù)至少輸入一個(gè)。
| cn-hangzhou |
VSwitchName | string | 否 | 交換機(jī)的名稱。 名稱長(zhǎng)度為 1~128 個(gè)字符,不能以 | vSwitch |
DryRun | boolean | 否 | 是否只預(yù)檢此次請(qǐng)求。取值:
| true |
IsDefault | boolean | 否 | 是否查詢指定地域下的默認(rèn)交換機(jī),取值:
如果不傳入該參數(shù),系統(tǒng)默認(rèn)查詢指定地域下的所有交換機(jī)。 | true |
RouteTableId | string | 否 | 路由表的 ID。 | vtb-bp145q7glnuzdvzu2**** |
ResourceGroupId | string | 否 | 交換機(jī)所屬的資源組 ID。 | rg-bp67acfmxazb4ph**** |
PageNumber | integer | 否 | 列表的頁碼,默認(rèn)值為 1。 | 1 |
PageSize | integer | 否 | 分頁查詢時(shí)每頁的行數(shù),最大值為 50。默認(rèn)值為 10。 | 10 |
VSwitchOwnerId | long | 否 | 資源歸屬的阿里云賬號(hào) ID。 | 2546073170691**** |
EnableIpv6 | boolean | 否 | 是否查詢指定地域下開啟 IPv6 網(wǎng)段的交換機(jī),取值:
如果不傳入該參數(shù),系統(tǒng)默認(rèn)查詢指定地域下的所有交換機(jī)。 | false |
Tag | array<object> | 否 | 資源的標(biāo)簽。 | |
object | 否 | 標(biāo)簽。 | ||
Key | string | 否 | 資源的標(biāo)簽鍵。最多支持輸入 20 個(gè)標(biāo)簽鍵。如需傳入該值,則不能輸入空字符串。 一個(gè)標(biāo)簽鍵最多支持 128 個(gè)字符,不能以 | FinanceDept |
Value | string | 否 | 資源的標(biāo)簽值。最多支持輸入 20 個(gè)標(biāo)簽值。如需傳入該值,可以輸入空字符串。 最多支持 128 個(gè)字符,不能以 | FinanceJoshua |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"PageSize": 10,
"RequestId": "9A572171-4E27-40D1-BD36-D26C9E71E29E",
"PageNumber": 1,
"TotalCount": 1,
"VSwitches": {
"VSwitch": [
{
"VpcId": "vpc-257gcdcdq64****",
"Status": "Available",
"CreationTime": "2022-01-18T12:43:57Z",
"IsDefault": true,
"AvailableIpAddressCount": 1,
"NetworkAclId": "nacl-a2do9e413e0spzasx****",
"OwnerId": 0,
"VSwitchId": "vsw-25bcdxs7pv1****",
"CidrBlock": "172.16.0.0/24",
"Description": "VSwitchDescription",
"ResourceGroupId": "rg-acfmxazb4ph6aiy****",
"ZoneId": "cn-hangzhou-d",
"Ipv6CidrBlock": "2408:4002:10c4:4e03::/64",
"VSwitchName": "vSwitch",
"ShareType": "Shared",
"EnabledIpv6": true,
"Tags": {
"Tag": [
{
"Key": "department",
"Value": "dev"
}
]
},
"RouteTable": {
"RouteTableId": "vrt-bp145q7glnuzdv****",
"RouteTableType": "System"
}
}
]
}
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
400 | Forbidden.VpcNotFound | Specified VPC can not found. | 指定的VPC不存在,請(qǐng)您檢查VPC是否正確。 |
400 | InvalidTagKey | The tag keys are not valid. | 無效的標(biāo)簽索引 |
400 | InvalidTagValue | The tag values are not valid. | 無效的標(biāo)簽值 |
400 | IellgalParameter.OwnerAccount | The specified parameter OwnerAccount is not valid. | 指定參數(shù) OwnerAccount 不合法 |
400 | IllegalParam.OwnerId | The specified parameter VSwitchOwnerId is not valid. | - |
404 | InvalidVSwitchId.NotFound | VSwitch not exist. | 該交換機(jī)不存在,請(qǐng)您檢查輸入的交換機(jī)是否正確。 |
404 | InvalidVpcIdNumber.NotSupported | The number of vpcIds exceeds the limit. | vpcId數(shù)量超出限制 |
404 | InvalidVSwitchIdNumber.NotSupported | The number of vSwitchIds exceeds the limit. | - |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-05-16 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2023-07-26 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
2023-07-26 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2023-07-05 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
2023-05-22 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |