文档首页/ IoT边缘 IoTEdge/ API参考/ API列表/ 北向NA管理/ 创建&更新北向NA信息
更新时间：2024-06-20 GMT+08:00
查看PDF
分享

创建&更新北向NA信息

功能介绍

创建&更新北向NA信息

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

PUT /v2/{project_id}/nas/{na_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取方法请参见 获取项目ID。

最小长度：1

最大长度：64

na_id

是

String

北向数据接收端点ID

最小长度：1

最大长度：32

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。

最小长度：0

最大长度：20000
表3 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

NA系统名称

最小长度：1

最大长度：64

description

否

String

北向NA系统描述

最小长度：0

最大长度：255

endpoint

是

String

访问URL地址

最小长度：1

最大长度：512

auth_type

否

String

鉴权方式

最小长度：1

最大长度：32

auth_aksk_info

否

AuthAkSkInfo object

AK/SK鉴权信息结构体

access_type

是

String

接入类型

最小长度：1

最大长度：32

access_roma_info

否

AccessRomaInfo object

接入方式为ROMA的鉴权信息结构体
表4 AuthAkSkInfo

参数

是否必选

参数类型

描述

secret

否

String

鉴权密钥

最小长度：1

最大长度：256
表5 AccessRomaInfo

参数

是否必选

参数类型

描述

app_key

否

String

认证key，加密存储

最小长度：1

最大长度：256

app_secret

否

String

认证secret，加密存储

最小长度：1

最大长度：256

响应参数

状态码： 200

表6 响应Body参数

参数

参数类型

描述

na_id

String

NA系统ID，提供给其他系统访问的唯一标识

最小长度：1

最大长度：32

name

String

NA系统名称

最小长度：1

最大长度：64

description

String

北向NA系统描述

最小长度：0

最大长度：255

endpoint

String

访问URL地址

最小长度：1

最大长度：512

auth_type

String

鉴权方式

最小长度：1

最大长度：32

access_type

String

接入类型

最小长度：1

最大长度：32

access_roma_info

AccessRomaBriefInfo object

ROMA接入鉴权信息

create_time

String

创建时间

最小长度：0

最大长度：256

update_time

String

更新时间

最小长度：0

最大长度：256
表7 AccessRomaBriefInfo

参数

参数类型

描述

app_key

String

认证key，加密存储

最小长度：1

最大长度：256

请求示例

PUT https://{endpoint}/v2/{project_id}/nas/{na_id}

{
  "name" : "string",
  "description" : "string",
  "endpoint" : "string",
  "auth_type" : "string",
  "auth_aksk_info" : {
    "secret" : "string"
  },
  "access_type" : "string",
  "access_roma_info" : {
    "app_key" : "string"
  }
}

响应示例

状态码： 200

OK

{
  "na_id" : "na_id_1",
  "name" : "北向系统1",
  "description" : "这是一个北向NA",
  "endpoint" : "https://068b72f3b75444dda67cc6e2286a4c20.apic.cn-south-1.huaweicloudapis.com",
  "auth_type" : "AKSK",
  "access_type" : "ROMA",
  "access_roma_info" : {
    "app_key" : "ebf59208-4c6b-4b06-9b69-494e9df475a3"
  },
  "create_time" : "2020-05-28T11:31:29.740Z",
  "update_time" : "2020-05-28T11:31:29.740Z"
}

状态码

状态码

描述

200

OK

400

Bad Request

403

Forbidden

错误码

请参见错误码。

父主题： 北向NA管理

相关文档