更新时间:2025-08-29 GMT+08:00
分享

设置双因子登录配置

功能介绍

设置双因子登录配置

调用方法

请参见如何调用API

URI

PUT /v5/{project_id}/setting/two-factor-login/config

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

enabled

Boolean

是否开启双因子认证

auth_type

String

认证类型

  • sms :短信邮件验证

  • code :验证码验证

topic_display_name

String

主题别名

topic_urn

String

主题的唯一资源标识

host_id_list

Array of strings

服务器列表

响应参数

状态码:200

请求已成功

请求示例

开启双因子认证,认证类型为短信邮件验证,主题别名为liuzhaoli,主题的唯一资源标识为urn:smn:cn-north-4:06ff15244b2748b49e69c2140b319e9e:liuzhaoling,服务器列表为09724867-7b91-482d-9702-daf9113f1b62。

{
  "enabled" : true,
  "auth_type" : "sms",
  "topic_display_name" : "liuzhaoli",
  "topic_urn" : "urn:smn:cn-north-4:06ff15244b2748b49e69c2140b319e9e:liuzhaoling",
  "host_id_list" : [ "09724867-7b91-482d-9702-daf9113f1b62" ]
}

响应示例

SDK代码示例

SDK代码示例如下。

开启双因子认证,认证类型为短信邮件验证,主题别名为liuzhaoli,主题的唯一资源标识为urn:smn:cn-north-4:06ff15244b2748b49e69c2140b319e9e:liuzhaoling,服务器列表为09724867-7b91-482d-9702-daf9113f1b62。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.hss.v5.region.HssRegion;
import com.huaweicloud.sdk.hss.v5.*;
import com.huaweicloud.sdk.hss.v5.model.*;

import java.util.List;
import java.util.ArrayList;

public class SetTwoFactorLoginConfigSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        HssClient client = HssClient.newBuilder()
                .withCredential(auth)
                .withRegion(HssRegion.valueOf("<YOUR REGION>"))
                .build();
        SetTwoFactorLoginConfigRequest request = new SetTwoFactorLoginConfigRequest();
        SetTwoFactorLoginConfigRequestBody body = new SetTwoFactorLoginConfigRequestBody();
        List<String> listbodyHostIdList = new ArrayList<>();
        listbodyHostIdList.add("09724867-7b91-482d-9702-daf9113f1b62");
        body.withHostIdList(listbodyHostIdList);
        body.withTopicUrn("urn:smn:cn-north-4:06ff15244b2748b49e69c2140b319e9e:liuzhaoling");
        body.withTopicDisplayName("liuzhaoli");
        body.withAuthType("sms");
        body.withEnabled(true);
        request.withBody(body);
        try {
            SetTwoFactorLoginConfigResponse response = client.setTwoFactorLoginConfig(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

开启双因子认证,认证类型为短信邮件验证,主题别名为liuzhaoli,主题的唯一资源标识为urn:smn:cn-north-4:06ff15244b2748b49e69c2140b319e9e:liuzhaoling,服务器列表为09724867-7b91-482d-9702-daf9113f1b62。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkhss.v5.region.hss_region import HssRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkhss.v5 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = HssClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(HssRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = SetTwoFactorLoginConfigRequest()
        listHostIdListbody = [
            "09724867-7b91-482d-9702-daf9113f1b62"
        ]
        request.body = SetTwoFactorLoginConfigRequestBody(
            host_id_list=listHostIdListbody,
            topic_urn="urn:smn:cn-north-4:06ff15244b2748b49e69c2140b319e9e:liuzhaoling",
            topic_display_name="liuzhaoli",
            auth_type="sms",
            enabled=True
        )
        response = client.set_two_factor_login_config(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

开启双因子认证,认证类型为短信邮件验证,主题别名为liuzhaoli,主题的唯一资源标识为urn:smn:cn-north-4:06ff15244b2748b49e69c2140b319e9e:liuzhaoling,服务器列表为09724867-7b91-482d-9702-daf9113f1b62。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := hss.NewHssClient(
        hss.HssClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.SetTwoFactorLoginConfigRequest{}
	var listHostIdListbody = []string{
        "09724867-7b91-482d-9702-daf9113f1b62",
    }
	request.Body = &model.SetTwoFactorLoginConfigRequestBody{
		HostIdList: listHostIdListbody,
		TopicUrn: "urn:smn:cn-north-4:06ff15244b2748b49e69c2140b319e9e:liuzhaoling",
		TopicDisplayName: "liuzhaoli",
		AuthType: "sms",
		Enabled: true,
	}
	response, err := client.SetTwoFactorLoginConfig(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档