Skip to content

Commit 90b3a1b

Browse files
shiyuhang0shiyuhang0
committed
add doc
1 parent a932421 commit 90b3a1b

7 files changed

Lines changed: 225 additions & 0 deletions

‎docs/generate_doc/ticloud_serverless.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ Manage TiDB Cloud Serverless clusters
3030
* [ticloud serverless export](ticloud_serverless_export.md) - Manage TiDB Cloud Serverless exports
3131
* [ticloud serverless import](ticloud_serverless_import.md) - Manage TiDB Cloud Serverless data imports
3232
* [ticloud serverless list](ticloud_serverless_list.md) - List all TiDB Cloud Serverless clusters
33+
* [ticloud serverless private-link-connection](ticloud_serverless_private-link-connection.md) - Manage private link connections
3334
* [ticloud serverless region](ticloud_serverless_region.md) - List all available regions for TiDB Cloud Serverless
3435
* [ticloud serverless shell](ticloud_serverless_shell.md) - Connect to a TiDB Cloud Serverless cluster
3536
* [ticloud serverless spending-limit](ticloud_serverless_spending-limit.md) - Set spending limit for a TiDB Cloud Serverless cluster

‎docs/generate_doc/ticloud_serverless_private-link-connection.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
## ticloud serverless private-link-connection
2+
3+
Manage private link connections
4+
5+
### Options
6+
7+
```
8+
-h, --help help for private-link-connection
9+
```
10+
11+
### Options inherited from parent commands
12+
13+
```
14+
-D, --debug Enable debug mode
15+
--no-color Disable color output
16+
-P, --profile string Profile to use from your configuration file
17+
```
18+
19+
### SEE ALSO
20+
21+
* [ticloud serverless](ticloud_serverless.md) - Manage TiDB Cloud Serverless clusters
22+
* [ticloud serverless private-link-connection create](ticloud_serverless_private-link-connection_create.md) - Create a private link connection
23+
* [ticloud serverless private-link-connection delete](ticloud_serverless_private-link-connection_delete.md) - Delete a private link connection
24+
* [ticloud serverless private-link-connection describe](ticloud_serverless_private-link-connection_describe.md) - Describe a private link connection
25+
* [ticloud serverless private-link-connection list](ticloud_serverless_private-link-connection_list.md) - List private link connections
26+
* [ticloud serverless private-link-connection zones](ticloud_serverless_private-link-connection_zones.md) - Get account and availability zones for private link connection
27+

‎docs/generate_doc/ticloud_serverless_private-link-connection_create.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
## ticloud serverless private-link-connection create
2+
3+
Create a private link connection
4+
5+
```
6+
ticloud serverless private-link-connection create [flags]
7+
```
8+
9+
### Examples
10+
11+
```
12+
Create a private link connection (interactive):
13+
$ ticloud serverless private-link-connection create
14+
15+
Create a private link connection which connect to alicloud endpoint service (non-interactive):
16+
$ ticloud serverless private-link-connection create -c <cluster-id> --display-name <name> --type ALICLOUD_ENDPOINT_SERVICE --alicloud.endpoint-service.name <name>
17+
18+
Create a private link connection which connect to aws endpoint service (non-interactive):
19+
$ ticloud serverless private-link-connection create -c <cluster-id> --display-name <name> --type AWS_ENDPOINT_SERVICE --aws.endpoint-service.name <name>
20+
```
21+
22+
### Options
23+
24+
```
25+
--alicloud.endpoint-service.name string Alicloud endpoint service name
26+
--aws.endpoint-service.name string AWS endpoint service name
27+
--aws.endpoint-service.region string AWS endpoint service region
28+
-c, --cluster-id string The cluster ID.
29+
--display-name string Display name for the private link connection.
30+
-h, --help help for create
31+
--type string Type of the private link connection, one of ["AWS_ENDPOINT_SERVICE" "ALICLOUD_ENDPOINT_SERVICE"]
32+
```
33+
34+
### Options inherited from parent commands
35+
36+
```
37+
-D, --debug Enable debug mode
38+
--no-color Disable color output
39+
-P, --profile string Profile to use from your configuration file
40+
```
41+
42+
### SEE ALSO
43+
44+
* [ticloud serverless private-link-connection](ticloud_serverless_private-link-connection.md) - Manage private link connections
45+

‎docs/generate_doc/ticloud_serverless_private-link-connection_delete.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## ticloud serverless private-link-connection delete
2+
3+
Delete a private link connection
4+
5+
```
6+
ticloud serverless private-link-connection delete [flags]
7+
```
8+
9+
### Examples
10+
11+
```
12+
Delete a private link connection (interactive):
13+
$ ticloud serverless private-link-connection delete
14+
15+
Delete a private link connection (non-interactive):
16+
$ ticloud serverless private-link-connection delete -c <cluster-id> -p <private-link-connection-id>
17+
```
18+
19+
### Options
20+
21+
```
22+
-c, --cluster-id string The cluster ID.
23+
--force Delete without confirmation.
24+
-h, --help help for delete
25+
-p, --private-link-connection-id string The private link connection ID.
26+
```
27+
28+
### Options inherited from parent commands
29+
30+
```
31+
-D, --debug Enable debug mode
32+
--no-color Disable color output
33+
-P, --profile string Profile to use from your configuration file
34+
```
35+
36+
### SEE ALSO
37+
38+
* [ticloud serverless private-link-connection](ticloud_serverless_private-link-connection.md) - Manage private link connections
39+

‎docs/generate_doc/ticloud_serverless_private-link-connection_describe.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## ticloud serverless private-link-connection describe
2+
3+
Describe a private link connection
4+
5+
```
6+
ticloud serverless private-link-connection describe [flags]
7+
```
8+
9+
### Examples
10+
11+
```
12+
Describe a private link connection (interactive):
13+
$ ticloud serverless private-link-connection describe
14+
15+
Describe a private link connection (non-interactive):
16+
$ ticloud serverless private-link-connection describe -c <cluster-id> -p <private-link-connection-id>
17+
```
18+
19+
### Options
20+
21+
```
22+
-c, --cluster-id string The cluster ID.
23+
-h, --help help for describe
24+
-p, --private-link-connection-id string The private link connection ID.
25+
```
26+
27+
### Options inherited from parent commands
28+
29+
```
30+
-D, --debug Enable debug mode
31+
--no-color Disable color output
32+
-P, --profile string Profile to use from your configuration file
33+
```
34+
35+
### SEE ALSO
36+
37+
* [ticloud serverless private-link-connection](ticloud_serverless_private-link-connection.md) - Manage private link connections
38+

‎docs/generate_doc/ticloud_serverless_private-link-connection_list.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## ticloud serverless private-link-connection list
2+
3+
List private link connections
4+
5+
```
6+
ticloud serverless private-link-connection list [flags]
7+
```
8+
9+
### Examples
10+
11+
```
12+
List private link connections (interactive):
13+
$ ticloud serverless private-link-connection list
14+
15+
Describe a private link connection (non-interactive):
16+
$ ticloud serverless private-link-connection list -c <cluster-id>
17+
```
18+
19+
### Options
20+
21+
```
22+
-c, --cluster-id string The cluster ID.
23+
-h, --help help for list
24+
-o, --output string Output format, one of ["human" "json"]. For the complete result, please use json format. (default "human")
25+
```
26+
27+
### Options inherited from parent commands
28+
29+
```
30+
-D, --debug Enable debug mode
31+
--no-color Disable color output
32+
-P, --profile string Profile to use from your configuration file
33+
```
34+
35+
### SEE ALSO
36+
37+
* [ticloud serverless private-link-connection](ticloud_serverless_private-link-connection.md) - Manage private link connections
38+

‎docs/generate_doc/ticloud_serverless_private-link-connection_zones.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
## ticloud serverless private-link-connection zones
2+
3+
Get account and availability zones for private link connection
4+
5+
```
6+
ticloud serverless private-link-connection zones [flags]
7+
```
8+
9+
### Examples
10+
11+
```
12+
Get availability zones (interactive):
13+
$ ticloud serverless private-link-connection get-zones
14+
15+
Get availability zones (non-interactive):
16+
$ ticloud serverless private-link-connection zones -c <cluster-id>
17+
```
18+
19+
### Options
20+
21+
```
22+
-c, --cluster-id string The cluster ID.
23+
-h, --help help for zones
24+
```
25+
26+
### Options inherited from parent commands
27+
28+
```
29+
-D, --debug Enable debug mode
30+
--no-color Disable color output
31+
-P, --profile string Profile to use from your configuration file
32+
```
33+
34+
### SEE ALSO
35+
36+
* [ticloud serverless private-link-connection](ticloud_serverless_private-link-connection.md) - Manage private link connections
37+

0 commit comments

Comments
 (0)