重置边缘实例密码--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

重置边缘实例密码

最近更新时间：2024.12.09 17:51:27首次发布时间：2022.02.25 18:58:31

本接口用于重置重置边缘实例的密码。密码类型允许修改。

使用说明

前提条件：

重置密码的实例需处于运行中状态。

注意事项：

重置实例的密码后，您必须重启实例才能使新密码生效。重启实例的操作请参考 RebootInstances。如果您登录实例的操作系统内部来重启实例，重置密码的操作不会生效。重启实例可能会影响您的业务。因此，建议您在业务流量低谷期执行该操作以降低对业务的影响。

Linux实例支持自定义密码和SSH Key。自定义密码意味着您需要通过用户名和密码登录实例。SSH Key意味着您需要通过密钥对方式登录实例。相较于用户名和密码方式的登录认证，密钥对方式的登录认证能够提供更高的安全性，因此推荐您使用密钥对。密码类型变更后，密码的有效性可能会发生变化。例如，如果您为一个Linux实例设置了自定义密码，然后将自定义密码变更为了密钥对，自定义密码会失效。
登录密码的有效性，请参见下表说明。

密码变更类型	旧的登录密码	新的登录密码
将SSH Key变更为自定义密码	可用	可用
将SSH Key变更为SSH Key	不可用	可用
将自定义密码变更为自定义密码	不可用	可用
将自定义密码变更为SSH Key	不可用	可用

请求说明

请求方式：POST
请求地址：https://veenedge.volcengineapi.com/?Action=ResetLoginCredential&Version=2021-04-30

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。其他公共参数，请参见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	ResetLoginCredential	公共参数。该参数表示接口名称。取值：ResetLoginCredential。
Version	String	是	2021-04-30	公共参数。该参数表示接口版本。取值：2021-04-30。

Body

参数	类型	是否必选	示例值	描述
instance_identity	String	是	veen1020125208252511****	边缘实例 ID。您可以通过 ListInstances 接口查询边缘实例 ID。
secret_type	Integer	是	3	边缘实例的登录密码类型。取值范围： 2：自定义密码。 3：SSH Key 类型密码。 4：代表不注入登录凭证。说明如果您创建的是 Windows 边缘实例，则 secret_type 必须指定为 2。相较于密码方式的登录认证，SSH Key 方式的登录认证能够提供更高的安全性。如果您创建的是 Linux 边缘实例，推荐您使用 SSH Key。 Linux 边缘实例的登录用户名默认为 root。Windows 边缘实例的登录用户名默认为 Administrator。
secret_data	String	是	My_password	登录密码。自定义密码：密码输入规则如下：允许 8 ~ 30个字符。密码须至少包含以下类型中的3种：大写字母、小写字母、数字和特殊字符。支持特殊字符 ()`~!@#$%^&*-+=_\|{}[]:;'<>,.?/。 \| 不能包含双引号（"）、反斜线（ \）和空格，且不能以正斜线（/）开头。 SSH Key 类型密码：输入SSH 密钥对的 ID。您可以通过 ListSSHKey 接口查询密钥对 ID。

参数

类型

是否必选

示例值

描述

instance_identity

String

是

veen1020125208252511****

边缘实例 ID。您可以通过 ListInstances 接口查询边缘实例 ID。

secret_type

Integer

是

边缘实例的登录密码类型。取值范围：

2：自定义密码。
3：SSH Key 类型密码。
4：代表不注入登录凭证。

说明

如果您创建的是 Windows 边缘实例，则 secret_type 必须指定为 2。
相较于密码方式的登录认证，SSH Key 方式的登录认证能够提供更高的安全性。如果您创建的是 Linux 边缘实例，推荐您使用 SSH Key。
Linux 边缘实例的登录用户名默认为 root。Windows 边缘实例的登录用户名默认为 Administrator。

secret_data

String

是

My_password

登录密码。

自定义密码：密码输入规则如下：
- 允许 8 ~ 30个字符。密码须至少包含以下类型中的3种：大写字母、小写字母、数字和特殊字符。
- 支持特殊字符 ()`~!@#$%^&*-+=_|{}[]:;'<>,.?/。 |
- 不能包含双引号（"）、反斜线（ \）和空格，且不能以正斜线（/）开头。
SSH Key 类型密码：输入SSH 密钥对的 ID。您可以通过 ListSSHKey 接口查询密钥对 ID。

返回参数

该接口无特有的返回参数。

请求示例

POST https://veenedge.volcengineapi.com/?Action=ResetLoginCredential&Version=2021-04-30
&<其他公共参数>
{
  "instance_identity": "veen21112705010175****",
  "secret_type": 2,
  "secret_data": "My_password"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202305251821543FE4E72F4433C311****",
        "Action": "ResetLoginCredential",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    }
}

错误码

如果响应正文中包含 Error 字段，则表示 API 请求失败。关于错误码的更多信息，参见错误码。