Atlas privateEndpoints Amazon Web Services describe
返回为项目指定的 Amazon Web Services 私有端点的详细信息。
要使用此命令，您必须使用具有“项目只读”角色的用户帐户或 API 密钥进行身份验证。
语法
命令语法
atlas privateEndpoints aws describe <privateEndpointId> [options]
参数
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
privateEndpointId | 字符串 | true | 唯一的 24 字符字母数字字符串，用于标识 Atlas 中的私有端点。 |
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
-h，--help | false | 描述帮助 | |
-o, --output | 字符串 | false | 输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出，请使用 -o json 选项。 |
--projectId | 字符串 | false | 标识要使用的项目的十六进制字符串。 此选项会覆盖配置文件或环境变量中的设置。 |
继承选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
-P, --profile | 字符串 | false | 要从配置文件中使用的配置文件的名称。 要了解 Atlas CLI 的配置文件，请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |
输出
如果命令成功，CLI 将返回类似于以下示例的输出。 括号中的值代表您的价值观。
ID ENDPOINT SERVICE STATUS ERROR <Id> <EndpointServiceName> <Status> <ErrorMessage>
示例
# Return the JSON-formatted details for the AWS private endpoint connection with the ID 5f4fc81c1f03a835c2728ff7 for the project with the ID 5e2211c17a3e5a48f5497de3: atlas privateEndpoints aws describe 5f4fc81c1f03a835c2728ff7 --projectId 5e2211c17a3e5a48f5497de3 --output json