配置无线网络APN接口资源信息
命令功能
配置无线网络APN接口资源信息。
命令格式
操作类型:PATCH
URL:https://device_ip/redfish/v1/Systems/LTE/ConfigInfo
请求头:
X-Auth-Token: auth_value
{
"apn_name": apnname,
"apn_user": apnuser,
"apn_passwd": apnpasswd,
"auth_type":authtype
}
请求参数
参数名 |
是否必选 |
参数说明 |
取值 |
|---|---|---|---|
apn_name |
必选 |
无线网络拨号时使用的APN名称,不允许为空。 |
字符串,可由大小写字母(a~z、A~Z)、数字(0~9)和其他字符(_-.@)组成,最大长度为39字符。 |
apn_user |
可选 |
无线网络拨号时使用的APN用户名,允许为空。apn_user和apn_passwd字段要么都为空,要么都不为空。请根据运营商提供的实际信息进行配置。 |
字符串。最大长度为64字符,可由大小写字母(a~z、A~Z)、数字(0~9)和其他字符(-_.@)组成。 |
apn_passwd |
可选 |
无线网络拨号时使用的APN密码,允许为空。apn_user和apn_passwd字段要么都为空,要么都不为空。请根据运营商提供的实际信息进行配置。 |
字符串。长度为1~64个字符,由数字、大小写字母及英文特殊符号~`!?, .:;-_'"(){}[]/<>@#^&$%*+|\=空格组成。 |
auth_type |
必选 |
身份验证类型。 |
字符串 取值为0、1、2、3,其含义分别为:
说明:
4G模块支持的auth_type取值为0、1、2;5G模块支持的auth_type的取值为0、1、2、3。 |
使用指南
接口已默认开发,功能根据无线网卡适配。
使用实例
请求样例:
PATCH https://10.10.10.10/redfish/v1/Systems/LTE/ConfigInfo
请求头:
X-Auth-Token: auth_value
请求消息体:
{
"apn_name": "apnname",
"apn_user": "apnuser",
"apn_passwd": "apnpasswd",
"auth_type": "1"
}
{
"error": {
"code": "Base.1.0.Success",
"message": "Operation success. See ExtendedInfo for more information.",
"@Message.ExtendedInfo": [
{
"@odata.type": "#MessageRegistry.v1_0_0.MessageRegistry",
"Description": "Indicates that no error has occurred.",
"Message": "Config LTE APN successfully.",
"Severity": "OK",
"NumberOfArgs": null,
"ParamTypes": null,
"Resolution": "None"
}
]
}
}
响应码:202
输出说明
字段 |
类型 |
说明 |
|---|---|---|
code |
字符串 |
指示消息注册表中特定消息ID的字符串。 |
message |
字符串 |
与消息注册表中的消息对应的易读的消息。 |
@odata.type |
字符串 |
消息资源的OData描述信息。 |
Description |
字符串 |
消息资源的具体描述。 |
Message |
字符串 |
消息资源的详细信息。 |
Severity |
字符串 |
严重性。支持的严重级别包括:
|
NumberOfArgs |
数字 |
消息描述的参数个数。 |
ParamTypes |
数组 |
参数类型列表。 |
Resolution |
字符串 |
事件处理建议。 |