更新时间:2026-03-23 GMT+08:00
分享

获取北向机机账户token

接口功能

多产业、多集群 场景下,提供北向获取token功能。

SLA项

定义

请求成功率

>=99.95%

可用性

Tier1

数据一致性

最终一致,不一致时长<1分钟

吞吐量

5tps

TP50请求时延

3000ms

TP99.9请求时延

3000ms

接口约束

多产业、多集群 场景下,使用Global统一域名地址。

调用方法

POST

URI

/rest/openapi/auth/v2/global/tokens

请求参数

表1 body参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

authCredit

REFERENCE

详细请参见表2

获取token的入参,包括用户身份信息和产业实例过滤信息

-

表2 AuthRequest对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

identity

REFERENCE

详细请参见表3

用户身份信息

-

scope

REFERENCE

详细请参见表4

产业实例过滤信息,可选,默认为所有产业实例。

-

表3 AuthCreditV2对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

userName

string

1~128个字符。

-

用户名

"xxxxxx"

password

password

5~128个字符。

-

该字段可能包含敏感信息和个人数据,请妥善做好保护。

用户密码

"******"

表4 AuthScope对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

products

array<string>

0-2 个列表项。

-

对接的产业类型集合,包括乾坤、DME-IQ、星光云等,目前仅支持如下产业类型:QIANKUN-SAAS、CLOUD-CAMPUS。产业类型间为或的关系,为空则表示全部产业。

-

instanceCodes

array<string>

0-100 个列表项。每个列表项1~128个字符。

-

云管实例Code集合。云管实例Code间为或的关系,为空则表示全部云管实例Code。目前支持的云管实例code为cn-north-4-instance-01、cn-east-2-cloudcampus-01,其中cn-north-4-instance-01对接了乾坤第二平面、cn-east-2-cloudcampus-01对接了CloudCampus中国区cn2。

-

请求示例

HTTP的示例
POST /rest/openapi/auth/v2/global/tokens HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json;charset=UTF-8
Accept: application/json
{
    "identity":{
        "userName": "xxxxxx",
        "password": "******"
    },
    "scope": {
       "products": [
          "QIANKUN-SAAS"
       ],
       "instanceCodes": [
          "cn-north-4-instance-01" 
       ]
    }
}

响应参数

返回状态码为200:获取token成功

表5 AuthTokenResponse对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

tokens

ARRAY_REFERENCE

详细请参见表6

-

-

表6 InstanceData对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

products

ARRAY_REFERENCE

详细请参见表7

产业认证凭据集合

-

instanceCode

string

-

-

云管实例Code,例如cn-north-4-instance-01。

-

表7 ProductData对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

type

string

-

-

对接的产业类型:乾坤、DME-IQ、星光云等,目前仅支持如下产业类型:QIANKUN-SAAS、CLOUD-CAMPUS。

-

url

string

0~128个字符。

-

产业实例北向访问地址,发起请求时需要拼接具体的请求路径。

"https://cloudcampus-naas-01.huawei.com:18002"

authToken

REFERENCE

详细请参见表8

-

-

表8 ProductAuthToken对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

token

string

0~1024个字符。

-

该字段可能包含敏感信息和个人数据,请妥善做好保护。

token标识,访问北向接口时需要添加请求头:x-auth-token,值为token对应的值。

"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

expiredDate

string

0~128个字符。

-

token过期时间,UTC时间,时间格式是:yyyy-MM-dd HH:mm:ss'

"2018-10-30 10:09:23"

返回状态码为401:认证失败

详细信息请参见实际响应消息体。

响应示例

返回状态码为200

HTTP/1.1 200 OK
Date: Mon,23 Mar 2026 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
	"tokens" : [
		{
			"products" : [
				{
					"url" : "https://cloudcampus-naas-01.huawei.com:18002",
					"authToken" : {
						"token" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
						"expiredDate" : "2018-10-30 10:09:23"
					}
				}
			]
		}
	]
}

返回状态码为401

HTTP/1.1 401 Unauthorized
Date: Mon,23 Mar 2026 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive

相关文档