云服务器内容精选

  • 请求示例 将指定高防实例IP的转发协议修改为tcp,转发端口和源站端口设置为31,源站IP修改为4.1.0.0。 PUT https://{endpoint}/v1/aad/instances/{instance_id}/{ip}/rules/{rule_id} { "forward_protocol" : "tcp", "forward_port" : 31, "source_port" : 31, "source_ip" : "4.1.0.0" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String token 最小长度:32 最大长度:2097152 Content-Type 是 String Content-Type 缺省值:application/json;charset=utf8 最小长度:1 最大长度:128 表3 请求Body参数 参数 是否必选 参数类型 描述 forward_protocol 否 String 转发协议,tcp或udp forward_port 否 Integer 转发端口 最小值:1 最大值:65536 source_port 否 Integer 源站端口 最小值:1 最大值:65536 source_ip 否 String 源站IP,多个IP用逗号隔开,限制20个IP 最小值:1 最大值:256
  • 响应示例 状态码: 201 POST操作正常返回。 { "rule" : { "compare_type" : "EQUAL_TO", "provisioning_status" : "ACTIVE", "project_id" : "99a3fff0d03c428eac3678da6a7d0f24", "invert" : false, "admin_state_up" : true, "value" : "/bbb.html", "key" : null, "type" : "PATH", "id" : "84f4fcae-9c15-4e19-a99f-72c0b08fd3d7" }, "request_id" : "3639f1b7-f04b-496e-9218-ec5a9e493f69" }
  • 请求示例 创建转发规则,并指定规则类型为路径 POST https://{ELB_Endpoint}/v3/{99a3fff0d03c428eac3678da6a7d0f24}/elb/l7policies/cf4360fd-8631-41ff-a6f5-b72c35da74be/rules { "rule" : { "compare_type" : "EQUAL_TO", "type" : "PATH", "value" : "/bbb.html" } }
  • 响应参数 状态码: 201 表6 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 注:自动生成 。 rule L7Rule object 转发规则对象。 表7 L7Rule 参数 参数类型 描述 admin_state_up Boolean 转发规则的管理状,默认为true。 不支持该字段,请勿使用。 compare_type String 转发规则的匹配方式。type为HOST_NAME时可以为EQUAL_TO。type为PATH时可以为REGEX, STARTS_WITH,EQUAL_TO。 key String 匹配内容的键值。type为HOST_NAME和PATH时,该字段不生效。 最小长度:1 最大长度:255 project_id String 转发规则所在的项目ID。 type String 转发规则类别。 取值: HOST_NAME:匹配 域名 。 PATH:匹配请求路径。 METHOD:匹配请求方法。 HEADER:匹配请求头。 QUERY_STRING:匹配请求查询参数。 SOURCE_IP:匹配请求源IP地址。 使用说明: 一个l7policy下创建的l7rule的HOST_NAME,PATH,METHOD,SOURCE_IP不能重复。 HEADER、QUERY_STRING支持重复的rule配置。 value String 匹配内容的值。仅当conditions空时该字段生效。 当type为HOST_NAME时,字符串只能包含英文字母、数字、-.,必须以字母、数字或开头。 若域名中包含*,则只能出现在开头且必须以.开始。当*开头时表示通配0~任一个字符。 当type为PATH时,当转发规则的compare_type为STARTS_WITH、EQUAL_TO时, 字符串只能包含英文字母、数字、_~';@^-%#&$.*+?,=!:|\/()[]{},且必须以/开头。 当type为METHOD、SOURCE_IP、HEADER, QUERY_STRING时,该字段无意义,使用condition_pair来指定key,value。 最小长度:1 最大长度:128 provisioning_status String provisioning状态,可以为ACTIVE、PENDING_CREATE 或者ERROR。 说明:该字段无实际含义,默认为ACTIVE。 invert Boolean 是否反向匹配。 使用说明:固定为false。该字段能更新但不会生效。 id String 规则ID。 conditions Array of RuleCondition objects 转发规则的匹配条件。当监听器的高级转发策略功能(enhance_l7policy_enable)开启后才会生效。 若转发规则配置了conditions,字段key、字段value的值无意义。 同一个rule内的conditions列表中所有key必须相同,value不允许重复。 created_at String 创建时间。格式:yyyy-MM-dd'T'HH:mm:ss'Z',UTC时区。 注意:独享型实例的历史数据以及共享型实例下的资源,不返回该字段。 updated_at String 更新时间。格式:yyyy-MM-dd'T'HH:mm:ss'Z',UTC时区。 注意:独享型实例的历史数据以及共享型实例下的资源,不返回该字段。 表8 RuleCondition 参数 参数类型 描述 key String 匹配项的名称。 当转发规则类别type为HOST_NAME、PATH、METHOD、SOURCE_IP时,该字段固定为空字符串。 当转发规则类别type为HEADER时,key表示请求头参数的名称,value表示请求头参数的值。 key的长度限制1-40字符,只允许包含字母、数字和-_。 当转发规则类别type为QUERY_STRING时,key表示查询参数的名称,value表示查询参数的值。 key的长度限制为1-128字符,不支持空格,中括号,大括号,尖括号,反斜杠,双引号, '#','&','|',‘%’,‘~’,字母区分大小写。 同一个rule内的conditions列表中所有key必须相同。 最小长度:1 最大长度:128 value String 匹配项的值。 当转发规则类别type为HOST_NAME时,key固定为空字符串,value表示域名的值。 value长度1-128字符,字符串只能包含英文字母、数字、-.*, 必须以字母、数字或*开头,*只能出现在开头且必须以*.开始。 当转发规则类别type为PATH时,key固定为空字符串,value表示请求路径的值。 value长度1-128字符。当转发规则的compare_type为STARTS_WITH、EQUAL_TO时, 字符串只能包含英文字母、数字、_~';@^-%#&$.*+?,=!:|\/()[]{},且必须以"/"开头。 当转发规则类别type为HEADER时,key表示请求头参数的名称,value表示请求头参数的值。 value长度限制1-128字符,不支持空格, 双引号,支持以下通配符:*(匹配0个或更多字符)和?(正好匹配1个字符)。 当转发规则类别type为QUERY_STRING时,key表示查询参数的名称,value表示查询参数的值。 value长度限制为1-128字符,不支持空格,中括号,大括号,尖括号,反斜杠,双引号, '#','&','|',‘%’,‘~’,字母区分大小写,支持通配符:*(匹配0个或更多字符)和?(正好匹配1个字符) 当转发规则类别type为METHOD时,key固定为空字符串,value表示请求方式。value取值范围为:GET, PUT, POST,DELETE, PATCH, HEAD, OPTIONS。 当转发规则类别type为SOURCE_IP时,key固定为空字符串,value表示请求源地址。 value为CIDR格式,支持ipv4,ipv6。例如192.168.0.2/32,2049::49/64。 同一个rule内的conditions列表中所有value不允许重复。 最小长度:1 最大长度:128
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM 鉴权Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 rule 是 CreateRuleOption object 转发规则对象。 表4 CreateRuleOption 参数 是否必选 参数类型 描述 admin_state_up 否 Boolean 转发规则的管理状态,默认为true。 不支持该字段,请勿使用。 compare_type 是 String 转发匹配方式。 取值: EQUAL_TO 表示精确匹配。 REGEX 表示正则匹配。 STARTS_WITH 表示前缀匹配。 使用说明: type为HOST_NAME时仅支持EQUAL_TO,支持通配符*。 type为PATH时可以为REGEX,STARTS_WITH,EQUAL_TO。 type为METHOD、SOURCE_IP时,仅支持EQUAL_TO。 type为HEADER、QUERY_STRING,仅支持EQUAL_TO,支持通配符*、?。 key 否 String 匹配项的名称,比如转发规则匹配类型是请求头匹配,则key表示请求头参数的名称。 不支持该字段,请勿使用。 最小长度:0 最大长度:255 value 是 String 匹配项的值。比如转发规则匹配类型是域名匹配,则value表示域名的值。仅当conditions空时该字段生效。 当转发规则类别type为HOST_NAME时,字符串只能包含英文字母、数字、-、.或*,必须以字母、数字或*开头。 若域名中包含*,则*只能出现在开头且必须以*.开始。 当*开头时表示通配0~任一个字符。 当转发规则类别type为PATH时,当转发规则的compare_type为STARTS_WITH、EQUAL_TO时, 字符串只能包含英文字母、数字、_~';@^-%#&$.*+?,=!:|\/()[]{},且必须以/开头。 当转发规则类别type为METHOD、SOURCE_IP、HEADER,QUERY_STRING时, 该字段无意义,使用conditions来指定key/value。 最小长度:1 最大长度:128 project_id 否 String 转发规则所在的项目ID。 最小长度:32 最大长度:32 type 是 String 转发规则类别。 取值: HOST_NAME:匹配域名。 PATH:匹配请求路径。 METHOD:匹配请求方法。 HEADER:匹配请求头。 QUERY_STRING:匹配请求查询参数。 SOURCE_IP:匹配请求源IP地址。 使用说明: 一个l7policy下创建的l7rule的HOST_NAME,PATH,METHOD,SOURCE_IP不能重复。 HEADER、QUERY_STRING支持重复的rule配置。 invert 否 Boolean 是否反向匹配。 取值:true、false,默认false。 不支持该字段,请勿使用。 conditions 否 Array of CreateRuleCondition objects 转发规则的匹配条件。当监听器的高级转发策略功能(enhance_l7policy_enable)开启后才会生效。 若转发规则配置了conditions,字段key、字段value的值无意义。 同一个rule内的conditions列表中所有key必须相同,value不允许重复。 表5 CreateRuleCondition 参数 是否必选 参数类型 描述 key 否 String 匹配项的名称。 当转发规则类别type为HOST_NAME、PATH、METHOD、SOURCE_IP时,该字段固定为空字符串。 当转发规则类别type为HEADER时,key表示请求头参数的名称,value表示请求头参数的值。 key的长度限制1-40字符,只允许包含字母、数字和-_。 当转发规则类别type为QUERY_STRING时,key表示查询参数的名称,value表示查询参数的值。 key的长度限制为1-128字符,不支持空格,中括号,大括号,尖括号, 反斜杠,双引号,'#','&','|',‘%’,‘~’,字母区分大小写。 同一个rule内的conditions列表中所有key必须相同。 最小长度:1 最大长度:128 value 是 String 匹配项的值。 当转发规则类别type为HOST_NAME时,key固定为空字符串,value表示域名的值。 value长度1-128字符,字符串只能包含英文字母、数字、-、.或*, 必须以字母、数字或*开头,*只能出现在开头且必须以*.开始。 当转发规则类别type为PATH时,key固定为空字符串,value表示请求路径的值。 value长度1-128字符。当转发规则的compare_type为STARTS_WITH、EQUAL_TO时, 字符串只能包含英文字母、数字、_~';@^-%#&$.*+?,=!:|\/()[]{},且必须以/开头。 当转发规则类别type为HEADER时,key表示请求头参数的名称,value表示请求头参数的值。 value长度限制1-128字符,不支持空格, 双引号,支持以下通配符:*(匹配0个或更多字符)和?(正好匹配1个字符)。 当转发规则类别type为QUERY_STRING时,key表示查询参数的名称,value表示查询参数的值。 value长度限制为1-128字符,不支持空格,中括号,大括号,尖括号,反斜杠,双引号, '#','&','|',‘%’,‘~’,字母区分大小写,支持通配符:*(匹配0个或更多字符)和?(正好匹配1个字符) 当转发规则类别type为METHOD时,key固定为空字符串,value表示请求方式。value取值范围为:GET, PUT, POST,DELETE, PATCH, HEAD, OPTIONS。 当转发规则类别type为SOURCE_IP时,key固定为空字符串,value表示请求源地址。 value为CIDR格式,支持ipv4,ipv6。例如192.168.0.2/32,2049::49/64。 同一个rule内的conditions列表中所有value不允许重复。 最小长度:1 最大长度:128
  • 请求示例 请求样例 更新转发规则 PUT https://{Endpoint}/v2/a31d2bdcf7604c0faaddb058e1e08819/elb/l7policies/5ae0e1e7-5f0f-47a1-b39f-5d4c428a1586/rules/c6f457b8-bf6f-45d7-be5c-a3226945b7b1 { "rule": { "compare_type": "STARTS_WITH", "value": "/ccc.html" } }
  • 响应示例 响应样例 { "rule": { "compare_type": "STARTS_WITH", "provisioning_status": "ACTIVE", "admin_state_up": true, "tenant_id": "a31d2bdcf7604c0faaddb058e1e08819", "project_id": "a31d2bdcf7604c0faaddb058e1e08819", "invert": false, "value": "/ccc.html", "key": null, "type": "PATH", "id": "c6f457b8-bf6f-45d7-be5c-a3226945b7b1" } }
  • 响应消息 表4 响应参数 参数 参数类型 描述 rule Rule object 转发规则对象。详见 表5。 表5 rule字段说明 参数 参数类型 描述 id String 转发规则ID tenant_id String 转发规则所在的项目ID。 支持的最大字符长度:255 project_id String 此参数和tenant_id参数含义一样,均指转发规则所在的项目ID。 admin_state_up Boolean 转发规则的管理状态; 该字段为预留字段,暂未启用。取值范围:true/false。 true表示开启。 false表示关闭。 type String 转发规则的匹配类型。 取值范围: HOST_NAME:匹配请求中的域名; PATH:匹配请求中的路径; compare_type String 转发匹配方式: type为HOST_NAME时,取值范围: EQUAL_TO:精确匹配; type为PATH时,取值范围: REGEX:正则匹配; STARTS_WITH:前缀匹配; EQUAL_TO:精确匹配。 invert Boolean 是否反向匹配; 取值范围:true/false。默认值:false; 该字段为预留字段,暂未启用。 key String 匹配内容的键值。默认为null。 该字段为预留字段,暂未启用。 支持的最大字符长度:255 value String 匹配内容的值。 支持的最大字符长度:128 当type为HOST_NAME时,取值范围:String (100),字符串只能包含英文字母、数字、“-”或“.”,且必须以字母或数字开头。 当type为PATH时,取值范围:String (128)。当转发规则的compare_type为STARTS_WITH、EQUAL_TO时,字符串只能包含英文字母、数字、_~';@^-%#&$.*+?,=!:| \/()[]{},且必须以"/"开头。 provisioning_status String 该字段为预留字段,暂未启用。 转发规则的配置状态,可以为ACTIVE。
  • 请求消息 表2 请求参数 参数 是否必选 参数类型 描述 rule 是 Rule object 转发规则对象。详见表3。 表3 rule字段说明 参数 是否必选 参数类型 描述 compare_type 否 String 转发匹配方式: type为HOST_NAME时,取值范围: EQUAL_TO:精确匹配; type为PATH时,取值范围: REGEX:正则匹配; STARTS_WITH:前缀匹配; EQUAL_TO:精确匹配。 admin_state_up 否 Boolean 转发规则的管理状态; 该字段为预留字段,暂未启用。默认为true。 invert 否 Boolean 是否反向匹配; 取值范围:true/false。默认值:false; 该字段为预留字段,暂未启用。 key 否 String 匹配内容的键值。默认为null。 该字段为预留字段,暂未启用。 支持的最大字符长度:255 value 否 String 匹配内容的值。不能包含空格。 支持的最大字符长度:128 当type为HOST_NAME时,取值范围:String (100),字符串只能包含英文字母、数字、“-”或“.”,且必须以字母或数字开头。 当type为PATH时,取值范围:String (128)。当转发规则的compare_type为STARTS_WITH、EQUAL_TO时,字符串只能包含英文字母、数字、_~';@^-%#&$.*+?,=!:| \/()[]{},且必须以"/"开头。
  • 请求示例 POST https://{Endpoint}/v5/iot/{project_id}/rulesContent-Type: application/jsonX-Auth-Token: ********Instance-Id: ********{ "name" : "string", "description" : "string", "condition_group" : { "time_range" : { "days_of_week" : "string", "start_time" : "string", "end_time" : "string" }, "logic" : "string", "conditions" : [ { "device_status_condition" : { "status_list" : [ "string" ] }, "device_property_condition" : { "device_id" : "string", "product_id" : "string", "filters" : [ { "path" : "string", "value" : "string", "operator" : "string" } ] }, "type" : "string", "device_message_condition" : { "product_id" : "string", "topic" : "string" } } ] }, "actions" : [ { "iota_forwarding" : { "project_id" : "string", "region_name" : "string" }, "roma_forwarding" : { "project_id" : "string", "region_name" : "string", "roma_push_type" : "string" }, "kafka_forwarding" : { "kafka_mechanism" : "string", "project_id" : "string", "kafka_addresses" : [ { "port" : 0, "ip" : "string", "domain" : "string" } ], "kafka_username" : "string", "region_name" : "string", "kafka_topic" : "string", "kafka_password" : "string" }, "obs_forwarding" : { "project_id" : "string", "bucket_name" : "string", "region_name" : "string", "location" : "string" }, "type" : "string", "dis_forwarding" : { "stream_name" : "string", "project_id" : "string", "stream_id" : "string", "region_name" : "string" }, "addition" : [ "string" ] } ], "rule_type" : "string", "status" : "string", "app_id" : "string", "edge_node_ids" : [ "string" ]}
  • 错误码 HTTP状态码 错误码 错误码英文描述 错误码中文描述 处理建议 400 IOTDA.000006 Invalid input data. 请求参数不合法 请排查请求参数是否符合华为云文档要求。 IOTDA.001001 Invalid input for this application. 应用参数不合法 请排查请求参数是否符合华为云文档要求。 IOTDA.010000 Invalid input for this rule. 规则参数不合法 请排查请求参数是否符合华为云文档要求。 IOTDA.010004 Invalid parameter in the rule condition. 规则条件不合法 请排查请求参数是否符合华为云文档要求 IOTDA.010005 Invalid parameter in the rule action. 规则动作参数不合法 请排查请求中action参数是否符合华为云文档要求。 IOTDA.010006 Repeated condition ID in the same rule. 规则条件ID重复 请重新命名规则条件ID后重试。 IOTDA.010007 Repeated action ID in the same rule. 规则动作ID重复 请重新命名规则动作ID后重试。 IOTDA.010008 The device with this condition does not exist. 规则条件中对应的设备不存在 请检查请求参数是否正确或设备在平台是否已经存在。 IOTDA.010009 The device with this action does not exist. 规则动作中对应的设备不存在 请检查请求参数是否正确或设备在平台是否已经存在。 IOTDA.010010 The device data with this condition does not exist. 规则条件中对应的设备信息不存在 请检查请求参数是否正确或设备在平台是否已经存在。 IOTDA.010011 The device data with this action does not exist. 规则动作中对应的设备信息不存在 请检查请求参数是否正确或设备在平台是否已经存在。 IOTDA.010012 The tag with this condition does not exist. 规则条件中对应的标签不存在 请检查请求参数是否正确或标签在平台是否已经存在 IOTDA.010013 Invalid rule parameter. 规则参数不合法 请排查请求参数是否符合华为云文档要求 IOTDA.010015 The rule count of each user has reached the upper limit, the current up limit is 10 entries. 用户下规则数量超过上限 请删除多余的规则后再注册。 403 IOTDA.000004 Invalid access token. 非法token 请排查请求中的token是否正常。 IOTDA.000021 Operation not allowed. User not found by IAM token or the authorized user has not subscribed IOTDA service. 没有找到IAM Token所对应的用户信息或该用户没有订阅 设备接入服务 (IOTDA) 请排查IAM Token所在用户是否订阅了设备接入服务(IOTDA)。 IOTDA.001000 The application does not exist. 该应用不存在 请确定是否已在平台注册应用并检查应用ID是否正确。 IOTDA.001002 Operation not allowed. The application has not been authorized. 该应用没有权限访问 请检查该应用是否已被授权。 IOTDA.001005 Operation not allowed. The parameter 'app_id' is not carried, and the authorized user has more than one applications. Include the parameter 'app_id', or contact Huawei technical support engineers to merge application data. 该用户下有多个应用的情况下未携带appId访问接口 请携带对应的appId或联系华为工程师合并应用数据。 IOTDA.001006 Operation not allowed. Application not found by authorized user or the authorized user has no application. 用户下没有应用或应用与用户不匹配 请排查用户下是否有应用或是否有指定的应用。 IOTDA.001007 Operation not allowed. The application does not belong to the authorized user. 应用与用户信息不匹配 请排查该用户下是否有指定的应用。 IOTDA.010003 The number of rules has reached the upper limit. 规则数量已达到上限 请删除多余的规则后重试。 404 IOTDA.010002 The rule does not exist. 该规则不存在 请确认平台是否存在该规则或请求参数是否正确。 500 IOTDA.000007 The data in database is abnormal. 数据库中的数据不正常 请联系华为工程师分析解决。 IOTDA.000020 Decrypt IAM token failed. IAM Token解析失败 请联系华为工程师分析解决。
  • 响应示例 Status Code: 201 Created Content-Type: application/json{ "rule_id" : "string", "name" : "string", "description" : "string", "condition_group" : { "conditions" : [ { "type" : "string", "device_property_condition" : { "device_id" : "string", "product_id" : "string", "filters" : [ { "path" : "string", "operator" : "string", "value" : "string" } ] }, "device_message_condition" : { "product_id" : "string", "topic" : "string" }, "device_status_condition" : { "status_list" : [ "string" ] } } ], "logic" : "string", "time_range" : { "start_time" : "string", "end_time" : "string", "days_of_week" : "string" } }, "actions" : [ { "type" : "string", "addition" : [ "string" ], "dis_forwarding" : { "region_name" : "string", "project_id" : "string", "stream_name" : "string", "stream_id" : "string" }, "obs_forwarding" : { "region_name" : "string", "project_id" : "string", "bucket_name" : "string", "location" : "string" }, "roma_forwarding" : { "region_name" : "string", "project_id" : "string", "roma_push_type" : "string" }, "iota_forwarding" : { "region_name" : "string", "project_id" : "string" }, "kafka_forwarding" : { "region_name" : "string", "project_id" : "string", "kafka_addresses" : [ { "ip" : "string", "port" : 0, "domain" : "string" } ], "kafka_topic" : "string", "kafka_username" : "string", "kafka_password" : "string", "kafka_mechanism" : "string" } } ], "rule_type" : "string", "status" : "string", "app_id" : "string", "edge_node_id" : [ "string" ], "last_update_time" : "string"}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String token 最小长度:32 最大长度:2097152 Content-Type 是 String Content-Type 缺省值:application/json;charset=utf8 最小长度:1 最大长度:128 表3 请求Body参数 参数 是否必选 参数类型 描述 rules 否 Array of TransferRuleBody objects 批量转发规则 表4 TransferRuleBody 参数 是否必选 参数类型 描述 forward_protocol 否 String 转发协议,tcp或udp forward_port 否 Integer 转发端口 最小值:1 最大值:65536 source_port 否 Integer 源站端口 最小值:1 最大值:65536 source_ip 否 String 源站IP,多个IP用逗号隔开,限制20个IP 最小值:1 最大值:256