调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
pts:GetUserVpcVSwitch | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
PageNumber | integer | 是 | 分页查询时的页码。 | 1 |
PageSize | integer | 是 | 每页显示记录条数。 | 1 |
RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
VpcId | string | 是 | 专有网络 ID。 | vpc-2ze22scdz2ebdfjasdfjkqhf4pyj |
返回参数
示例
正常返回示例
JSON
格式
{
"Code": "200",
"HttpStatusCode": 200,
"Message": "空",
"PageNumber": 1,
"PageSize": 5,
"RequestId": "0235E5FC-4C7C-5F0C-843C-FC674F15F947",
"Success": true,
"VSwitchCount": 6,
"VSwitchList": [
{
"AvailableIpAddressCount": 1000,
"MaxAgentCount": 1000,
"VSwitchId": "vsw-bp1eil9df23rsd8l1sevebiszooj",
"VSwitchName": "my-vswitch",
"VpcId": "vpc-wz9bpdaebft6j23fesdf84v2f1um3a"
}
]
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
403 | Code | The specified parameter is invalid. | 输入参数有误 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2022-04-12 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2022-04-12 | 新增 OpenAPI | 查看变更详情 |