mirror of https://github.com/status-im/consul.git
DOCS: CE-556 Add partition parameter to API endpoint docs (#21374)
* CD-556 rename partition partial that's only used in CLI Update CLI pages for partial rename API: Add partial for partition as body option API: Add partial for partition as query parameter Update API peering and members pages * acl/auth-methods.mdx Update partition partials to be generic * binding-rules.mdx, policies.mdx * roles.mdx, templated-policies.mdx * tokens.mdx, catalog.mdx, config.mdx, intentions.mdx * service.mdx, exported-services.mdx, kv.mdx, namespaces.mdx * Apply suggestions from code review Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> * Add partial to acl/auth-methods.mdx Fix headings indent in a few files. * Update website/content/api-docs/acl/auth-methods.mdx Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> --------- Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>
This commit is contained in:
parent
a9d92d020d
commit
654528ca60
|
@ -107,6 +107,8 @@ The corresponding CLI command is [`consul acl auth-method create`](/consul/comma
|
|||
prefixed-${serviceaccount.name}
|
||||
```
|
||||
|
||||
@include 'http-api-body-options-partition.mdx'
|
||||
|
||||
### Sample Payload
|
||||
|
||||
```json
|
||||
|
@ -178,6 +180,8 @@ The corresponding CLI command is [`consul acl auth-method read`](/consul/command
|
|||
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the auth method you look up.
|
||||
You can also [specify the namespace through other methods](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
|
@ -294,6 +298,8 @@ The corresponding CLI command is [`consul acl auth-method update`](/consul/comma
|
|||
prefixed-${serviceaccount.name}
|
||||
```
|
||||
|
||||
@include 'http-api-body-options-partition.mdx'
|
||||
|
||||
### Sample Payload
|
||||
|
||||
```json
|
||||
|
@ -369,6 +375,8 @@ The corresponding CLI command is [`consul acl auth-method delete`](/consul/comma
|
|||
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the auth method you delete.
|
||||
You can also [specify the namespace through other methods](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
|
@ -408,8 +416,9 @@ The corresponding CLI command is [`consul acl auth-method list`](/consul/command
|
|||
The namespace may be specified as '\*' to return results for all namespaces.
|
||||
You can also [specify the namespace through other methods](#methods-to-specify-namespace).
|
||||
|
||||
The namespace may be specified as '\*' and then
|
||||
results will be returned for all namespaces.
|
||||
The namespace may be specified as '\*' and then results are returned for all namespaces.
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
## Sample Request
|
||||
|
||||
|
|
|
@ -172,6 +172,8 @@ The corresponding CLI command is [`consul acl binding-rule create`](/consul/comm
|
|||
This field takes precedence over the `ns` query parameter,
|
||||
one of several [other methods to specify the namespace](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-body-options-partition.mdx'
|
||||
|
||||
### Sample Payload
|
||||
|
||||
```json
|
||||
|
@ -238,6 +240,8 @@ The corresponding CLI command is [`consul acl binding-rule read`](/consul/comman
|
|||
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the binding rule you lookup.
|
||||
You can also [specify the namespace through other methods](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
|
@ -423,6 +427,8 @@ The corresponding CLI command is [`consul acl binding-rule update`](/consul/comm
|
|||
This field takes precedence over the `ns` query parameter,
|
||||
one of several [other methods to specify the namespace](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-body-options-partition.mdx'
|
||||
|
||||
### Sample Payload
|
||||
|
||||
```json
|
||||
|
@ -489,6 +495,8 @@ The corresponding CLI command is [`consul acl binding-rule delete`](/consul/comm
|
|||
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the binding rule you delete.
|
||||
You can also [specify the namespace through other methods](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
|
@ -522,7 +530,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
The corresponding CLI command is [`consul acl binding-rule list`](/consul/commands/acl/binding-rule/list).
|
||||
|
||||
## Query Parameters
|
||||
### Query Parameters
|
||||
|
||||
- `authmethod` `(string: "")` - Filters the binding rule list to those binding
|
||||
rules that are linked with the specific named auth method.
|
||||
|
@ -531,7 +539,9 @@ The corresponding CLI command is [`consul acl binding-rule list`](/consul/comman
|
|||
The namespace may be specified as '\*' to return results for all namespaces.
|
||||
You can also [specify the namespace through other methods](#methods-to-specify-namespace).
|
||||
|
||||
## Sample Request
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
$ curl --request GET http://127.0.0.1:8500/v1/acl/binding-rules
|
||||
|
|
|
@ -57,6 +57,8 @@ The corresponding CLI command is [`consul acl policy create`](/consul/commands/a
|
|||
This field takes precedence over the `ns` query parameter,
|
||||
one of several [other methods to specify the namespace](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-body-options-partition.mdx'
|
||||
|
||||
### Sample Payload
|
||||
|
||||
```json
|
||||
|
@ -170,6 +172,8 @@ The corresponding CLI command is [`consul acl policy read -name=<string>`](/cons
|
|||
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the policy you lookup.
|
||||
You can also [specify the namespace through other methods](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
|
@ -242,6 +246,8 @@ The corresponding CLI command is [`consul acl policy update`](/consul/commands/a
|
|||
This field takes precedence over the `ns` query parameter,
|
||||
one of several [other methods to specify the namespace](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-body-options-partition.mdx'
|
||||
|
||||
### Sample Payload
|
||||
|
||||
```json
|
||||
|
@ -307,6 +313,8 @@ The corresponding CLI command is [`consul acl policy delete`](/consul/commands/a
|
|||
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the policy you delete.
|
||||
You can also [specify the namespace through other methods](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
|
@ -346,7 +354,9 @@ The corresponding CLI command is [`consul acl policy list`](/consul/commands/acl
|
|||
The namespace may be specified as '\*' to return results for all namespaces.
|
||||
You can also [specify the namespace through other methods](#methods-to-specify-namespace).
|
||||
|
||||
## Sample Request
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
$ curl --request GET http://127.0.0.1:8500/v1/acl/policies
|
||||
|
|
|
@ -95,6 +95,8 @@ The corresponding CLI command is [`consul acl role create`](/consul/commands/acl
|
|||
This field takes precedence over the `ns` query parameter,
|
||||
one of several [other methods to specify the namespace](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-body-options-partition.mdx'
|
||||
|
||||
### Sample Payload
|
||||
|
||||
```json
|
||||
|
@ -223,6 +225,8 @@ The corresponding CLI command is [`consul acl role read`](/consul/commands/acl/r
|
|||
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the role you lookup.
|
||||
You can also [specify the namespace through other methods](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
|
@ -306,6 +310,8 @@ The corresponding CLI command is [`consul acl role read -name=<string>`](/consul
|
|||
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the role you lookup.
|
||||
You can also [specify the namespace through other methods](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
|
@ -418,6 +424,8 @@ The corresponding CLI command is [`consul acl role update`](/consul/commands/acl
|
|||
This field takes precedence over the `ns` query parameter,
|
||||
one of several [other methods to specify the namespace](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-body-options-partition.mdx'
|
||||
|
||||
### Sample Payload
|
||||
|
||||
```json
|
||||
|
@ -523,6 +531,8 @@ The corresponding CLI command is [`consul acl role delete`](/consul/commands/acl
|
|||
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the role you delete.
|
||||
You can also [specify the namespace through other methods](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
|
@ -565,6 +575,8 @@ The corresponding CLI command is [`consul acl role list`](/consul/commands/acl/r
|
|||
The namespace may be specified as '\*' to return results for all namespaces.
|
||||
You can also [specify the namespace through other methods](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
## Sample Request
|
||||
|
||||
```shell-session
|
||||
|
|
|
@ -87,6 +87,8 @@ The corresponding CLI command is [`consul acl templated-policy preview`](/consul
|
|||
|
||||
- `Name` `(string: <optional>)` - Specifies the value of the `name` variable in the templated policy variables.
|
||||
|
||||
@include 'http-api-body-options-partition.mdx'
|
||||
|
||||
### Sample payload
|
||||
|
||||
```json
|
||||
|
|
|
@ -118,6 +118,8 @@ The corresponding CLI command is [`consul acl token create`](/consul/commands/ac
|
|||
This field takes precedence over the `ns` query parameter,
|
||||
one of several [other methods to specify the namespace](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-body-options-partition.mdx'
|
||||
|
||||
### Sample Payload
|
||||
|
||||
```json
|
||||
|
@ -217,6 +219,8 @@ The corresponding CLI command is [`consul acl token read`](/consul/commands/acl/
|
|||
- `expanded` `(bool: false)` - If this field is set, the contents of all policies and
|
||||
roles affecting the token will also be returned.
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
|
@ -497,6 +501,8 @@ The corresponding CLI command is [`consul acl token update`](/consul/commands/ac
|
|||
This field takes precedence over the `ns` query parameter,
|
||||
one of several [other methods to specify the namespace](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-body-options-partition.mdx'
|
||||
|
||||
### Sample Payload
|
||||
|
||||
```json
|
||||
|
@ -591,6 +597,8 @@ The corresponding CLI command is [`consul acl token clone`](/consul/commands/acl
|
|||
This field takes precedence over the `ns` query parameter,
|
||||
one of several [other methods to specify the namespace](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-body-options-partition.mdx'
|
||||
|
||||
### Sample Payload
|
||||
|
||||
```json
|
||||
|
@ -668,6 +676,8 @@ The corresponding CLI command is [`consul acl token delete`](/consul/commands/ac
|
|||
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the token you delete.
|
||||
You can also [specify the namespace through other methods](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
|
@ -723,6 +733,8 @@ The corresponding CLI command is [`consul acl token list`](/consul/commands/acl/
|
|||
The namespace may be specified as '\*' to return results for all namespaces.
|
||||
You can also [specify the namespace through other methods](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
|
|
|
@ -261,6 +261,8 @@ The corresponding CLI command is [`consul members`](/consul/commands/members).
|
|||
network segment). When querying a server, setting this to the special string `_all`
|
||||
will show members in all segments.
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
|
|
|
@ -684,6 +684,8 @@ The `/agent/service/register` endpoint supports camel case and _snake case_ for
|
|||
`false`. See [anti-entropy syncs](/consul/docs/architecture/anti-entropy) for
|
||||
additional information.
|
||||
|
||||
@include 'http-api-body-options-partition.mdx'
|
||||
|
||||
#### Connect Structure
|
||||
|
||||
For the `Connect` field, the parameters are:
|
||||
|
@ -769,6 +771,8 @@ The corresponding CLI command is [`consul services deregister`](/consul/commands
|
|||
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the service you deregister.
|
||||
You can also [specify the namespace through other methods](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
|
|
|
@ -327,6 +327,8 @@ The corresponding CLI command is [`consul catalog nodes`](/consul/commands/catal
|
|||
- `filter` `(string: "")` - Specifies the expression used to filter the
|
||||
queries results prior to returning the data.
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
|
@ -422,6 +424,8 @@ The corresponding CLI command is [`consul catalog services`](/consul/commands/ca
|
|||
- `filter` `(string: "")` - Specifies the expression used to filter the
|
||||
queries results prior to returning the data.
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Filtering
|
||||
|
||||
The filter will be executed against each Service mapping within the catalog.
|
||||
|
|
|
@ -71,6 +71,8 @@ The ACL required depends on the config entry being written:
|
|||
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the config entry you apply.
|
||||
You can also [specify the namespace through other methods](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Payload
|
||||
|
||||
```json
|
||||
|
@ -150,6 +152,8 @@ The ACL required depends on the config entry kind being read:
|
|||
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the config entry you lookup
|
||||
You can also [specify the namespace through other methods](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
|
@ -228,6 +232,8 @@ The corresponding CLI command is [`consul config list`](/consul/commands/config/
|
|||
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the config entries you lookup.
|
||||
You can also [specify the namespace through other methods](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
|
@ -321,6 +327,8 @@ The corresponding CLI command is [`consul config delete`](/consul/commands/confi
|
|||
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the config entry you delete.
|
||||
You can also [specify the namespace through other methods](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
|
|
|
@ -60,6 +60,8 @@ The corresponding CLI command is [`consul intention create -replace`](/consul/co
|
|||
as shown in the [source and destination naming conventions](/consul/commands/intention#source-and-destination-naming).
|
||||
You can also [specify the namespace through other methods](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### JSON Request Body Schema
|
||||
|
||||
- `SourceType` `(string: "")` - The type for the `SourceName` value.
|
||||
|
@ -151,6 +153,8 @@ The corresponding CLI command is [`consul intention create`](/consul/commands/in
|
|||
as shown in the [source and destination naming conventions](/consul/commands/intention#source-and-destination-naming).
|
||||
You can also [specify the namespace through other methods](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### JSON Request Body Schema
|
||||
|
||||
- `SourceName` `(string: <required>)` - The source of the intention.
|
||||
|
@ -290,6 +294,8 @@ The corresponding CLI command is [`consul intention get`](/consul/commands/inten
|
|||
as shown in the [source and destination naming conventions](/consul/commands/intention#source-and-destination-naming).
|
||||
You can also [specify the namespace through other methods](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
|
@ -404,6 +410,8 @@ The corresponding CLI command is [`consul intention list`](/consul/commands/inte
|
|||
The `*` wildcard may be used to list intentions from all namespaces.
|
||||
You can also [specify the namespace through other methods](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
|
@ -485,6 +493,8 @@ The corresponding CLI command is [`consul intention delete`](/consul/commands/in
|
|||
as shown in the [source and destination naming conventions](/consul/commands/intention#source-and-destination-naming).
|
||||
You can also [specify the namespace through other methods](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
|
@ -628,6 +638,8 @@ The corresponding CLI command is [`consul intention match`](/consul/commands/int
|
|||
as shown in the [source and destination naming conventions](/consul/commands/intention#source-and-destination-naming).
|
||||
You can also [specify the namespace through other methods](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
|
|
|
@ -36,8 +36,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
### Query Parameters
|
||||
|
||||
- `partition` `(string: "")` <EnterpriseAlert inline /> - Specifies the admin partition the services are exported from. When not specified, assumes the default value `default`.
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
|
|
|
@ -79,6 +79,8 @@ The corresponding CLI command is [`consul kv get`](/consul/commands/kv/get).
|
|||
For recursive lookups, the namespace may be specified as '\*'
|
||||
to return results for all namespaces.
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
|
@ -220,6 +222,8 @@ The corresponding CLI command is [`consul kv put`](/consul/commands/kv/put).
|
|||
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to query.
|
||||
You can also [specify the namespace through other methods](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Payload
|
||||
|
||||
The payload is arbitrary, and is loaded directly into Consul as supplied.
|
||||
|
@ -289,6 +293,8 @@ The corresponding CLI command is [`consul kv delete`](/consul/commands/kv/delete
|
|||
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to query.
|
||||
You can also [specify the namespace through other methods](#methods-to-specify-namespace).
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
|
|
|
@ -67,6 +67,8 @@ The corresponding CLI command is [`consul namespace create`](/consul/commands/na
|
|||
- `Meta` `(map<string|string>: <optional>)` - Specifies arbitrary KV metadata
|
||||
to associate with the namespace.
|
||||
|
||||
@include 'http-api-body-options-partition.mdx'
|
||||
|
||||
### Sample Payload
|
||||
|
||||
```json
|
||||
|
@ -169,6 +171,10 @@ The corresponding CLI command is [`consul namespace read`](/consul/commands/name
|
|||
|
||||
- `name` `(string: <required>)` - Specifies the namespace to read.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
|
@ -272,6 +278,8 @@ The corresponding CLI command is [`consul namespace update`](/consul/commands/na
|
|||
- `Meta` `(map<string|string>: <optional>)` - Specifies arbitrary KV metadata
|
||||
to associate with the namespace.
|
||||
|
||||
@include 'http-api-body-options-partition.mdx'
|
||||
|
||||
### Sample Payload
|
||||
|
||||
```json
|
||||
|
@ -348,18 +356,15 @@ $ curl --request PUT \
|
|||
|
||||
## Delete a Namespace
|
||||
|
||||
This endpoint marks a Namespace for deletion. Once marked Consul will
|
||||
deleted all the associated Namespaced data in the background. Only once
|
||||
all associated data has been deleted will the Namespace actually disappear.
|
||||
Until then, further reads can be performed on the namespace and a `DeletedAt`
|
||||
field will now be populated with the timestamp of when the Namespace was
|
||||
marked for deletion.
|
||||
This endpoint marks a Namespace for deletion. Once marked, Consul deletes all the associated Namespaced data in the background. Only after all associated data has been deleted, Consul deletes the Namespace.
|
||||
Until then, you can perform further reads on the namespace, and a `DeletedAt`
|
||||
field is populated with the timestamp of when the Namespace was marked for deletion.
|
||||
|
||||
| Method | Path | Produces |
|
||||
| -------- | ------------------ | -------- |
|
||||
| `DELETE` | `/namespace/:name` | N/A |
|
||||
|
||||
This endpoint will return no data. Success or failure is indicated by the status
|
||||
This endpoint returns no data. Success or failure is indicated by the status
|
||||
code returned.
|
||||
|
||||
The table below shows this endpoint's support for
|
||||
|
@ -378,6 +383,10 @@ The corresponding CLI command is [`consul namespace delete`](/consul/commands/na
|
|||
|
||||
- `name` `(string: <required>)` - Specifies the namespace to delete.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
|
@ -449,6 +458,10 @@ the request has been granted any access in the namespace (read, list or write).
|
|||
|
||||
The corresponding CLI command is [`consul namespace list`](/consul/commands/namespace/list).
|
||||
|
||||
### Query Parameters
|
||||
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
|
|
|
@ -34,8 +34,7 @@ The table below shows this endpoint's support for
|
|||
and configuration entries such as `service-intentions`. This field must be a
|
||||
valid DNS hostname label.
|
||||
|
||||
- `Partition` `(string: "")` - <EnterpriseAlert inline /> The admin partition that the
|
||||
peering token is generated from. Uses `default` when not specified.
|
||||
@include 'http-api-body-options-partition.mdx'
|
||||
|
||||
- `ServerExternalAddresses` `([]string: <optional>)` - The addresses for the cluster that generates the peering token. Addresses take the form `{host or IP}:port`.
|
||||
You can specify one or more load balancers or external IPs that route external traffic to this cluster's Consul servers.
|
||||
|
@ -100,9 +99,7 @@ The table below shows this endpoint's support for
|
|||
and configuration entries such as `service-intentions`. This field must be a
|
||||
valid DNS hostname label.
|
||||
|
||||
- `Partition` `(string: "")` - <EnterpriseAlert inline /> The admin partition
|
||||
that peers to the cluster that generated the peering token. Uses `default`
|
||||
when not specified.
|
||||
@include 'http-api-body-options-partition.mdx'
|
||||
|
||||
- `PeeringToken` `(string: <required>)` - The peering token fetched from the
|
||||
peer cluster.
|
||||
|
@ -162,8 +159,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
### Query Parameters
|
||||
|
||||
- `partition` `(string: "")` <EnterpriseAlert inline /> - Specifies the partition of the peering
|
||||
to read. If not specified will default to `default`.
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
|
@ -235,8 +231,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
### Query Parameters
|
||||
|
||||
- `partition` `(string: "")` <EnterpriseAlert inline /> - Specifies the partition of the peerings
|
||||
to delete. If not specified will default to `default`.
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
|
@ -286,8 +281,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
### Query Parameters
|
||||
|
||||
- `partition` `(string: "")` <EnterpriseAlert inline /> - Specifies the partition of the peerings
|
||||
to list. If not specified will default to `default`.
|
||||
@include 'http-api-query-parms-partition.mdx'
|
||||
|
||||
### Sample Request
|
||||
|
||||
|
|
|
@ -67,7 +67,7 @@ Usage: `consul acl auth-method create [options] [args]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -31,7 +31,7 @@ Usage: `consul acl auth-method delete [options]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -34,7 +34,7 @@ Usage: `consul acl auth-method list`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -36,7 +36,7 @@ Usage: `consul acl auth-method read [options] [args]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -72,7 +72,7 @@ Usage: `consul acl auth-method update [options] [args]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -47,7 +47,7 @@ Usage: `consul acl binding-rule create [options] [args]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -32,7 +32,7 @@ Usage: `consul acl binding-rule delete [options]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -34,7 +34,7 @@ Usage: `consul acl binding-rule list`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -37,7 +37,7 @@ Usage: `consul acl binding-rule read [options] [args]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -54,7 +54,7 @@ Usage: `consul acl binding-rule update [options] [args]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -49,7 +49,7 @@ Usage: `consul acl policy create [options] [args]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -34,7 +34,7 @@ Usage: `consul acl policy delete [options]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -34,7 +34,7 @@ Usage: `consul acl policy list`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -39,7 +39,7 @@ Usage: `consul acl policy read [options] [args]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -58,7 +58,7 @@ Usage: `consul acl policy update [options] [args]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -52,7 +52,7 @@ Usage: `consul acl role create [options] [args]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -34,7 +34,7 @@ Usage: `consul acl role delete [options]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -34,7 +34,7 @@ Usage: `consul acl role list`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -39,7 +39,7 @@ Usage: `consul acl role read [options] [args]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -63,7 +63,7 @@ Usage: `consul acl role update [options] [args]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -36,7 +36,7 @@ Usage: `consul acl templated-policy preview [options] [args]`
|
|||
|
||||
### Enterprise options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -38,7 +38,7 @@ Usage: `consul acl token clone [options]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -66,7 +66,7 @@ Usage: `consul acl token create [options] [args]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -32,7 +32,7 @@ Usage: `consul acl token delete [options]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -34,7 +34,7 @@ Usage: `consul acl token list`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -43,7 +43,7 @@ Usage: `consul acl token read [options] [args]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -93,7 +93,7 @@ instead.
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -85,7 +85,7 @@ Usage: `consul catalog nodes [options]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
#### API Options
|
||||
|
||||
|
|
|
@ -69,7 +69,7 @@ Usage: `consul catalog services [options]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -61,7 +61,7 @@ config entry. This is used in combination with the -cas flag.
|
|||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
#### API Options
|
||||
|
||||
|
|
|
@ -48,7 +48,7 @@ Usage: `consul config list [options]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -52,7 +52,7 @@ Usage: `consul config read [options]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -53,7 +53,7 @@ Usage: `consul config write [options] FILE`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -199,7 +199,7 @@ compatibility with Envoy and prevent potential issues. Default is `false`.
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -60,7 +60,7 @@ Usage: `consul connect redirect-traffic [options]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -41,7 +41,7 @@ Usage: `consul intention check [options] SRC DST`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -52,7 +52,7 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -37,7 +37,7 @@ Usage:
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -37,7 +37,7 @@ Usage:
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -40,7 +40,7 @@ Usage: `consul intention match [options] SRC_OR_DST`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -40,7 +40,7 @@ Usage: `consul kv delete [options] KEY_OR_PREFIX`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -28,7 +28,7 @@ Usage: `consul kv export [options] [PREFIX]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -56,7 +56,7 @@ Usage: `consul kv get [options] [KEY_OR_PREFIX]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -31,7 +31,7 @@ Usage: `consul kv import [options] [DATA]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -59,7 +59,7 @@ Usage: `consul kv put [options] KEY [DATA]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -56,7 +56,7 @@ Usage: `consul members [options]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
#### API Options
|
||||
|
||||
|
|
|
@ -61,7 +61,7 @@ from the CLI arguments.
|
|||
|
||||
#### API Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_options_client.mdx'
|
||||
|
||||
|
|
|
@ -30,7 +30,7 @@ Usage: `consul namespace delete <name>`
|
|||
|
||||
#### API Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_options_client.mdx'
|
||||
|
||||
|
|
|
@ -42,7 +42,7 @@ Usage: `consul namespace list`
|
|||
|
||||
#### API Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_options_client.mdx'
|
||||
|
||||
|
|
|
@ -41,7 +41,7 @@ Usage: `consul namespace read <name>`
|
|||
|
||||
#### API Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_options_client.mdx'
|
||||
|
||||
|
|
|
@ -68,7 +68,7 @@ with the existing namespace definition.
|
|||
|
||||
#### API Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_options_client.mdx'
|
||||
|
||||
|
|
|
@ -40,7 +40,7 @@ or HCL format. See [here](/consul/docs/enterprise/namespaces#namespace-definitio
|
|||
|
||||
#### API Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_options_client.mdx'
|
||||
|
||||
|
|
|
@ -34,7 +34,7 @@ Usage: `consul peering delete [options] -name <peer name>`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
#### API Options
|
||||
|
||||
|
|
|
@ -36,7 +36,7 @@ Usage: `consul peering establish [options] -name <peer name> -peering-token <tok
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
#### API Options
|
||||
|
||||
|
|
|
@ -31,7 +31,7 @@ Usage: `consul peering exported-services [options] -name <peer name>`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
#### API Options
|
||||
|
||||
|
|
|
@ -43,7 +43,7 @@ You can specify one or more load balancers or external IPs that route external t
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
#### API Options
|
||||
|
||||
|
|
|
@ -30,7 +30,7 @@ Usage: `consul peering list [options]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
#### API Options
|
||||
|
||||
|
|
|
@ -31,7 +31,7 @@ Usage: `consul peering read [options] -name <peer name>`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
#### API Options
|
||||
|
||||
|
|
|
@ -43,7 +43,7 @@ This flexibility makes it easy to pair the command with the
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -40,7 +40,7 @@ Usage: consul services export [options] -name <service name> -consumer-peers <ot
|
|||
- `-consumer-partitions=<string>` - A comma-separated list of admin partitions within the
|
||||
same datacenter to export the service to. This flag is optional when `-consumer-peers` is specified.
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -32,7 +32,7 @@ Usage: `consul services exported-services [options]`
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
#### API Options
|
||||
|
||||
|
|
|
@ -78,7 +78,7 @@ The following fields specify identical parameters in a standard service definiti
|
|||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
@include 'cli-http-api-partition-options.mdx'
|
||||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
|
|
|
@ -0,0 +1 @@
|
|||
- `-partition=<string>` - <EnterpriseAlert inline /> Specifies the admin partition to query. If not provided, the partition is inferred from the request's ACL token, or defaults to the `default` partition.
|
|
@ -0,0 +1,2 @@
|
|||
|
||||
- `Partition` `(string: "")` - <EnterpriseAlert inline /> The admin partition to use. If not provided, the partition is inferred from the request's ACL token, or defaults to the `default` partition.
|
|
@ -0,0 +1 @@
|
|||
- `partition` `(string: "")` <EnterpriseAlert inline /> - The admin partition to use. If not provided, the partition is inferred from the request's ACL token, or defaults to the `default` partition.
|
|
@ -1 +0,0 @@
|
|||
- `-partition=<string>` - Specifies the partition to query. If not provided, the partition will be inferred from the request's ACL token, or will default to the `default` partition. Partitions are a Consul Enterprise feature added in v1.11.0.
|
Loading…
Reference in New Issue