Lists network connections.
Try it now
Test
RAM authorization
Request syntax
GET /api/v1/workspaces/{workspaceId}/networkServices HTTP/1.1Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| workspaceId |
string |
No |
The workspace ID. |
w-d2d82aa09155**** |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| regionId |
string |
No |
The region ID. |
cn-hangzhou |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response structure. |
||
| queues |
array<object> |
This parameter is deprecated. |
|
|
array<object> |
This parameter is deprecated. |
||
| workspaceId |
string |
This parameter is deprecated. |
w-d2d82aa09155**** |
| networkServiceId |
string |
This parameter is deprecated. |
ns-d7a1d02045fb**** |
| name |
string |
This parameter is deprecated. |
test |
| type |
string |
This parameter is deprecated. |
NetworkService |
| vpcId |
string |
This parameter is deprecated. |
vpc-uf6k2anfa9nzbm4cj**** |
| vswitchIds |
array |
This parameter is deprecated. |
|
|
string |
This parameter is deprecated. |
vsw-bp1yc4kfdjxq9s1zn**** |
|
| state |
string |
This parameter is deprecated. |
running |
| stateChangeReason |
object |
This parameter is deprecated. |
|
| code |
string |
This parameter is deprecated. |
code |
| message |
string |
This parameter is deprecated. |
message |
| networkServices |
array<object> |
A list of network connections. |
|
|
array<object> |
A network connection. |
||
| workspaceId |
string |
The ID of the workspace. |
w-d2d82aa09155**** |
| networkServiceId |
string |
The ID of the network connection. |
ns-d7a1d02045fb**** |
| name |
string |
The name of the network connection. |
vpc_test |
| type |
string |
The type of the network connection. |
NetworkService |
| vpcId |
string |
The VPC ID. |
vpc-bp1vt6r7o1w4tw7j6**** |
| vswitchIds |
array |
The list of vSwitch IDs. |
|
|
string |
The vSwitch ID. |
vsw-bp1yc4kfdjxq9s1zn**** |
|
| state |
string |
The state of the network connection. |
running |
| stateChangeReason |
object |
The reason for the state change. |
|
| code |
string |
The status code. |
code |
| message |
string |
The message that provides details about the state change. |
message |
| nextToken |
string |
The pagination token that is used in the next request to retrieve a new page of results. If this parameter is empty, all results have been returned. |
1 |
| maxResults |
integer |
The maximum number of entries to return on each page. |
20 |
| totalCount |
integer |
The total number of entries. |
200 |
| requestId |
string |
The request ID. |
18C7775A-7995-128A-A10C-9116EA87**** |
Examples
Success response
JSON format
{
"queues": [
{
"workspaceId": "w-d2d82aa09155****",
"networkServiceId": "ns-d7a1d02045fb****\n",
"name": "test",
"type": "NetworkService",
"vpcId": "vpc-uf6k2anfa9nzbm4cj****",
"vswitchIds": [
"vsw-bp1yc4kfdjxq9s1zn****"
],
"state": "running",
"stateChangeReason": {
"code": "code",
"message": "message"
}
}
],
"networkServices": [
{
"workspaceId": "w-d2d82aa09155****\n",
"networkServiceId": "ns-d7a1d02045fb****",
"name": "vpc_test",
"type": "NetworkService",
"vpcId": "vpc-bp1vt6r7o1w4tw7j6****",
"vswitchIds": [
"vsw-bp1yc4kfdjxq9s1zn****"
],
"state": "running",
"stateChangeReason": {
"code": "code",
"message": "message"
}
}
],
"nextToken": "1",
"maxResults": 20,
"totalCount": 200,
"requestId": "18C7775A-7995-128A-A10C-9116EA87****"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.