华为云用户手册

JSON样例 "from-config-values": { "configs": [ { "inputs": [ { "name": "fromJobConfig.inputDirectory", "value": "/sftpfrom/from_sftp.csv" }, { "name": "fromJobConfig.inputFormat", "value": "CSV_FILE" }, { "name": "fromJobConfig.columnList", "value": "1&2&3&4&5&6&7&8&9&10&11&12" }, { "name": "fromJobConfig.fieldSeparator", "value": "," }, { "name": "fromJobConfig.regexSeparator", "value": "false" }, { "name": "fromJobConfig.firstRowAsHeader", "value": "false" }, { "name": "fromJobConfig.encodeType", "value": "UTF-8" }, { "name": "fromJobConfig.fromCompression", "value": "NONE" }, { "name": "fromJobConfig.splitType", "value": "FILE" } ], "name": "fromJobConfig" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 restart 是 restart object 集群重启操作，定义哪些集群节点需要重启，请参见restart参数说明 表4 restart 参数 是否必选 参数类型 描述 restartDelayTime 否 Integer 重启时延，单位：秒 restartMode 否 String 重启类型： IMMEDIATELY：立即重启。 FORCELY：强制重启。 SOFTLY：一般重启。 默认值为“IMMEDIATELY”。强制重启业务进程会中断，并重启集群的虚拟机。 restartLevel 否 String 重启级别： SERVICE：重启服务。 VM：重启虚拟机。 默认值为“SERVICE”。 type 是 String 集群节点类型，只支持“cdm” instance 否 String 预留字段，“restartLevel” 为“SERVICE”时，“instance”必填，填空字串。 group 否 String 预留字段，“restartLevel” 为“SERVICE”时，“group”必填，填空字串。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 submissions Array of Submission objects 作业运行信息，详见submissions参数说明。 total Integer 查询该作业总的历史记录数。 page_no Integer 查询作业记录时，分页数。 page_size Integer 分页查询，每页返回的记录数。默认值：10。 表5 Submission 参数 参数类型 描述 isIncrementing Boolean 作业是否为增量迁移 job-name String 作业名称 counters counters object 作业运行结果统计，当“status”为“SUCCEEDED”时才有此字段，请参见counters数据结构参数说明 isStopingIncrement String 是否停止增量迁移 is-execute-auto Boolean 是否定时执行作业 last-update-date Long 作业最后更新时间 last-udpate-user String 最后更新作业状态的用户 isDeleteJob Boolean 作业执行完成后是否删除 creation-user String 创建用户 creation-date Long 创建时间 external-id String 作业ID progress Float 作业进度，失败时为“-1”，其它情况为0～100 submission-id Integer 作业提交id delete_rows Integer 删除数据行数 update_rows Integer 更新数据行数 write_rows Integer 写入数据行数 execute-date Long 执行时间 status String 作业状态： BOOTING：启动中。 FAILURE_ON_SUBMIT：提交失败。 RUNNING：运行中。 SUCCEEDED：成功。 FAILED：失败。 UNKNOWN：未知。 NEVER_EXECUTED：未被执行 error-details String 错误详情，当“status”为“FAILED”时才有此字段。 error-summary String 错误总结，当“status”为“FAILED”时才有此字段。 表6 counters 参数 参数类型 描述 org.apache.sqoop.submission.counter.SqoopCounters counter object 作业运行结果统计，请参见统计结果参数说明 表7 counter 参数 参数类型 描述 BYTES_WRITTEN Long 写入的字节数 TOTAL_FILES Integer 总文件数 ROWS_READ Long 读取的行数 BYTES_READ Long 读取的字节数 ROWS_WRITTEN Long 写入的行数 FILES_WRITTEN Integer 写入的文件数 FILES_READ Integer 读取的文件数 TOTAL_SIZE Long 总字节数 FILES_SKIPPED Integer 跳过的文件数 ROWS_WRITTEN_SKIPPED Long 跳过的行数

URI GET /v1.1/{project_id}/clusters/{cluster_id}/cdm/submissions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参见项目ID和账号ID cluster_id 是 String 集群ID 表2 Query参数 参数 是否必选 参数类型 描述 jname 是 String 作业名称

JSON样例 "to-config-values": { "configs": [ { "inputs": [ { "name": "toJobConfig.streamName", "value": "cdm" }, { "name": "toJobConfig.separator", "value": "," }, { "name": "toJobConfig.identifierEnclose", "value": "'" } ], "name": "toJobConfig" } ] }

参数说明 Redis源端作业参数说明 参数 是否必选 类型 说明 fromJobConfig.isBatchMigration 否 Boolean 是否为整库迁移。 fromJobConfig.keyPrefix 是 String key前缀，对应关系表的表名。 Redis和关系表的映射：用关系表的“表名+分隔符”来对应Redis的Key；关系表的一行数据对应Redis的Value。 fromJobConfig.keySeparator 是 String key分隔符，一般用来分割关系表和主键。 fromJobConfig.valueStoreType 是 String 关系表行数据在Redis中的存储方式分为“string”和“hash”两种存储方式。 STRING：表示用字符串通过分隔符来表示一行数据的各列，可以有效节省存储空间。 HASH：表示一行数据通过“列名：列值”的方式存储在hash表中。 fromJobConfig.valueSeparator 否 String 值分隔符号，当“valueStoreType”为“STRING”时此参数有效，默认值为：“\tab”。 fromJobConfig.columnList 否 String 需要抽取的字段列表，字段名之间使用“&”分割，例如：“id&gid&name”。 fromJobConfig.formats 否 数据结构 时间格式，请参见fromJobConfig.formats参数说明。 fromJobConfig.formats参数说明 参数 是否必选 类型 说明 name 是 String 列号，例如：“1”。 value 是 String 时间格式，例如：“yyyy-MM-dd”。

JSON样例 "from-config-values": { "configs": [ { "inputs": [ { "name": "fromJobConfig.isBatchMigration", "value": "false" }, { "name": "fromJobConfig.keyPrefix", "value": "rf_string_from" }, { "name": "fromJobConfig.keySeparator", "value": ":" }, { "name": "fromJobConfig.valueStoreType", "value": "STRING" }, { "name": "fromJobConfig.valueSeparator", "value": "," }, { "name": "fromJobConfig.columnList", "value": "1&2&3&4&5&6&7&8&9&10&11&12" } ], "name": "fromJobConfig" } ] }

连接样例 { "links": [ { "link-config-values": { "configs": [ { "inputs": [ { "name": "linkConfig.kafkaType", "value": "Platinum" }, { "name": "linkConfig.brokerList", "value": "100.85.121.112:9094,100.85.220.134:9094,100.85.127.232:9094" }, { "name": "linkConfig.isPlatinumInstance", "value": "false" } ], "name": "linkConfig" } ], "extended-configs": { "name": "linkConfig.extendedFields", "value": "e30=" } }, "name": "dms_kafka", "connector-name": "dms-kafka-connector" } ] }

连接参数 参数 是否必选 类型 说明 linkConfig.kafkaType 是 枚举 选择DMS Kafka版本,目前只有专享版。 Basic：指DMS Kafka普通队列。 Platinum：指DMS Kafka专享版。 linkConfig.brokerList 是 String DMS Endpoint格式为“host1:port1,host2:port2”。 linkConfig.isPlatinumInstance 是 Boolean 选择是否打开客户端连接Kafka专享版实例时SSL认证的开关。 开启Kafka SASL_SSL，则数据加密传输，安全性更高，但性能会下降。 linkConfig.user 否 String 开启Kafka SASL_SSL时显示该参数，表示连接DMS Kafka的用户名。 linkConfig.password 否 String 开启Kafka SASL_SSL时显示该参数，表示连接DMS Kafka的密码。

连接样例 { "links": [ { "link-config-values": { "configs": [ { "inputs": [ { "name": "linkConfig.hadoopType", "value": "MRS" }, { "name": "linkConfig.host", "value": "192.168.1.147" }, { "name": "linkConfig.user", "value": "liuhuan1" }, { "name": "linkConfig.password", "value": "Add password here." }, { "name": "linkConfig.authType", "value": "KERBEROS" } ], "name": "linkConfig" } ], "extended-configs": { "name": "linkConfig.extendedFields", "value": "e30=" } }, "name": "mrs_kafka_link", "connector-name": "kafka-connector" } ] }

连接参数 参数 是否必选 类型 说明 linkConfig.hadoopType 是 枚举 Hadoop类型： MRS：表示连接MRS的Kafka。 Apache Kafka：表示连接Apache Kafka的Kafka。 linkConfig.brokerList 是 String Apache Kafka 连接需配置此参数。Kafka broker列表，格式如：“host1:port1,host2:port2”。 llinkConfig.host 是 String MRS Manager的浮动IP地址，可以单击输入框后的“选择”来选定已创建的MRS集群，CDM会自动填充下面的鉴权参数。 linkConfig.user 是 String 登录MRS Manager平台的用户名。 linkConfig.password 是 String 登录MRS Manager平台的密码。 linkConfig.authType 是 枚举 认证类型，分为以下两种： Simple：非安全模式选择Simple鉴权。 Kerberos：安全模式选择Kerberos鉴权。 linkConfig.properties 否 Map 属性配置，可以添加客户端的配置属性，所添加的每个属性需配置属性名称和值

参数说明 HBase/CloudTable作业参数说明 参数 是否必选 类型 说明 fromJobConfig.table 是 String 需要抽取数据的表名，例如“cdm”。 fromJobConfig.columnFamilies 否 String 抽取数据所属的列族。 fromJobConfig.columns 否 String 需要抽取的列，列号之间使用“&”分割，列族与列之间用“:”分隔，例如：“cf1:c1&cf2:c2”。 fromJobConfig.isSplit 否 Boolean 选择是否拆分Rowkey，例如“true”。 fromJobConfig.delimiter 否 String 用于切分Rowkey的分隔符，若不设置则不切分，例如“|”。 fromJobConfig.startTime 否 String 时间区间左边界（包含该值），格式为“yyyy-MM-dd hh:mm:ss”。 表示只抽取该时间及以后的数据。 fromJobConfig.endTime 否 String 时间区间右边界（不包含该值），格式为“yyyy-MM-dd hh:mm:ss”。 表示只抽取该时间以前的数据。 fromJobConfig.formats 否 数据结构 时间格式，请参见fromJobConfig.formats参数说明。 fromJobConfig.formats参数说明 参数 是否必选 类型 说明 name 是 String 列号，例如：“1”。 value 是 String 时间格式，例如：“yyyy-MM-dd”。

JSON样例 "from-config-values": { "configs": [ { "inputs": [ { "name": "fromJobConfig.table", "value": "rf_from" }, { "name": "fromJobConfig.columnFamilies", "value": "rowkey&f" }, { "name": "fromJobConfig.columns", "value": "rowkey:rowkey&f:_small" }, { "name": "fromJobConfig.formats", "value": { "f:_date": "yyyy-MM-dd", "f:_timestamp": "yyyy-MM-dd HH:mm:ss" } } ], "name": "fromJobConfig" } ] }

连接样例 { "links": [ { "link-config-values": { "configs": [ { "inputs": [ { "name": "linkConfig.host", "value": "10.120.205.230" }, { "name": "linkConfig.authType", "value": "KERBEROS" }, { "name": "linkConfig.user", "value": "cdm" }, { "name": "linkConfig.password", "value": "Add password here" } ], "name": "linkConfig" } ] }, "name": "hive_link", "connector-name": "hive-connector" } ] }

连接参数 参数 是否必选 类型 说明 llinkConfig.host 是 String MRS Manager的IP地址。 linkConfig.authType 是 枚举 访问MRS的认证类型： SIMPLE：非安全模式选择Simple鉴权。 KERBEROS：安全模式选择Kerberos鉴权。 linkConfig.principal 否 String Kerveros认证所需的Principal，您也可以联系管理员获取此账号。使用集群配置前需在集群配置管理中配置此参数。 linkConfig.keytab 否 FileContent Kerveros认证所需的keytab文件的本地绝对路径，您也可以联系管理员获取此文件。使用集群配置前需在集群配置管理中配置此参数。 linkConfig.hiveVersion 是 枚举 Hive版本： HIVE_1_X HIVE_3_X linkConfig.user 否 String 登录Manager平台的用户名，使用集群配置时不用配置 linkConfig.password 否 String 登录Manager平台的密码，使用集群配置时不用配置 linkConfig.uri 否 String 连接Apache Hadoop时的Namenode URI地址，格式为“ip:port” linkConfig.hiveMsUris 否 String 连接Apache Hadoop时的Hive元数据地址，参考 hive.metastore.uris配置项。例如：thrift://host-192-168-1-212:9083 linkConfig.obsSupport 是 Boolean 需服务端支持OBS存储。在创建Hive表时，您可以指定将表存储在OBS中。 linkConfig.runMode 是 枚举 “HIVE_3_X”版本支持该参数。支持以下模式： EMBEDDED：连接实例与CDM运行在一起，该模式性能较好。 STANDALONE：连接实例运行在独立进程。如果CDM需要对接多个Hadoop数据源（MRS、Hadoop或CloudTable），并且既有KERBEROS认证模式又有SIMPLE认证模式，只能使用STANDALONE模式或者配置不同的Agent。 说明：STANDALONE模式主要是用来解决版本冲突问题的运行模式。当同一种数据连接的源端或者目的端连接器的版本不一致时，存在jar包冲突的情况，这时需要将源端或目的端放在STANDALONE进程里，防止冲突导致迁移失败。 linkConfig.accessKey 否 String 访问标识（AK）。obs支持选是时需配置此参数。 linkConfig.securityKey 否 String 密钥（SK）。obs支持选是时需配置此参数。 linkConfig.properties 否 Map 属性配置，可以添加客户端的配置属性，所添加的每个属性需配置属性名称和值

JSON样例 "from-config-values": { "configs": [ { "inputs": [ { "name": "fromJobConfig.topicsList", "value": "est1,est2" }, { "name": "fromJobConfig.kafkaConsumerStrategy", "value": "EARLIEST" }, { "name": "fromJobConfig.isPermanency", "value": "true" } ], "name": "fromJobConfig" } ] }

参数说明 参数 是否必选 类型 说明 fromJobConfig.topicsList 是 String Kafka topic列表，可以为多个topic，以“,”作为分隔符。 fromJobConfig.kafkaConsumerStrategy 是 枚举 从Kafka拉取数据时的初始偏移量设置： LATEST：最大偏移量，即最新的数据。 EARLIEST：最小偏移量，即最老的数据。 fromJobConfig.isPermanency 是 Boolean 是否永久运行。 fromJobConfig.groupId 否 String 用户指定消费组ID。 如果是从DMS Kafka导出数据，专享版请任意输入，标准版请输入有效的消费组ID。 fromJobConfig.dataFormat 是 枚举 解析数据时使用的格式： BINARY：适用于文件迁移场景，不解析数据内容原样传输。 CSV：以CSV格式解析源数据。 fromJobConfig.maxPollRecords 否 String 每次向Kafka请求数据限制最大请求记录数。 fromJobConfig.maxPollInterval 否 String 每次poll之间的最大时间间隔。 fromJobConfig.separator 否 String 字段分隔符。

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示。 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "id": "xxxxxxxxxxxxxxxxxx" } } } } scope参数定义了Token的作用范围，取值为project或domain，示例中取值为project，表示获取的Token仅能访问指定project下的资源。取值为domain时，表示获取的token可以访问指定账号下所有资源。 scope参数的详细说明，请参见获取用户Token接口， 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”的值，就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 需要添加到请求中的公共消息头如表3所示。 表3 公共请求消息头 名称 描述 是否必选 示例 Content-type 消息体的类型（格式），默认取值为“application/json”。 如果请求消息体中含有中文字符，则还需要通过charset=utf8指定中文字符集。 是 application/json;charset=utf8 Content-Length 请求body长度，单位为Byte。 否 3495 X-Project-Id project id，用于不同project取token。 否 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token，也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 是 - X-Language 请求语言。 是 en_us x-sdk-date 请求的发生时间，格式为(YYYYMMDD'T'HHMMSS'Z')。 取值为当前系统的GMT时间。 否 20190407T101459Z Host 请求的服务器信息，从服务API的URL中获取，值为“hostname[:port]”。端口缺省时使用默认的端口，https的默认端口为443。 否 code.test.com 或 code.test.com:443 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务您正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

请求URI 请求URI由如下部分组成。 {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 表1 请求URI 参数 说明 URI-scheme 传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 承载REST服务端点的服务器域名或IP，不同服务在不同区域时，对应Endpoint不同，可以从终端节点中获取。 例如IAM服务在“华北-北京一”区域的Endpoint为“iam.cn-north-1.myhuaweicloud.com”。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数，可选，查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如您需要获取“华北-北京一”区域的Token，则需使用“华北-北京一”区域的Endpoint（iam.cn-north-1.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，服务每个具体API的URI，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

响应示例 【示例一】 { "subnets": [ { "name": "kesmdemeet", "cidr": "172.16.236.0/24", "id": "011fc878-5521-4654-a1ad-f5b0b5820302", "enable_dhcp": true, "network_id": "48efad0c-079d-4cc8-ace0-dce35d584124", "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "dns_nameservers": [], "allocation_pools": [ { "start": "172.16.236.2", "end": "172.16.236.251" } ], "host_routes": [], "ip_version": 4, "gateway_ip": "172.16.236.1", "created_at": "2018-03-26T08:23:43", "updated_at": "2018-03-26T08:23:44" } ], "subnets_links": [ { "rel": "next", "href": "https://{Endpoint}/v2.0/subnets?limit=1&marker=011fc878-5521-4654-a1ad-f5b0b5820302" }, { "rel": "previous", "href": "https://{Endpoint}/v2.0/subnets?limit=1&marker=011fc878-5521-4654-a1ad-f5b0b5820302&page_reverse=True" } ] }

URI GET /v2.0/subnets 样例： GET https://{Endpoint}/v2.0/subnets?name={subnet_name}&ip_version={ip_version}&network_id={network_id}&cidr={subnet_cidr_address}&gateway_ip={subnet_gateway}&tenant_id={tenant_id}&enable_dhcp={is_enable_dhcp} 分页查询样例： GET https://{Endpoint}/v2.0/subnets?limit=2&marker=011fc878-5521-4654-a1ad-f5b0b5820302&page_reverse=False

响应参数 表2 响应参数 参数名称 类型 说明 subnets Array of subnet objects subnet对象列表，参见表3。 subnets_links Array of subnets_link objects 分页信息，参见表6 。 只有在使用limit过滤，并且资源个数超过limit或者资源个数超过2000时（limit默认值），该参数的rel和href取值才会显示为next和其对应的link。 表3 subnet对象 属性 类型 说明 id String 子网的id 【使用说明】在查询子网列表时非必选 name String 子网的名称 ip_version Integer IP版本 【使用说明】支持4（IPv4）、6（IPv6） ipv6_address_mode String IPv6寻址模式 【使用说明】仅支持dhcpv6-stateful ipv6_ra_mode String IPv6路由广播模式 【使用说明】仅支持dhcpv6-stateful network_id String 所属网络的id cidr String CIDR格式 【使用说明】IPV4只支持10.0.0.0/8,172.16.0.0/12,192.168.0.0/16三个网段内的地址，掩码长度不能大于28。 约束:当ip_version=6时,该字段不支持设置 gateway_ip String 网关IP不允许和allocation_pools地址块冲突。 【使用说明】不支持修改。 allocation_pools Array of allocation_pool objects 可用的IP池，allocation_pool对象参见表3 allocation_pool对象 例如：[ { "start": "10.0.0.2", "end": "10.0.0.251"} ] 每个子网的第1个和最后3个IP地址为系统保留地址。以192.168.1.0/24为例，192.168.1.0、 192.168.1.253、192.168.1.254和192.168.1.255这些地址是系统保留地址。 [{"start": "2001:db8:a583:9::2", "end": "2001:db8:a583:9:ffff:ffff:ffff:fffc"}] ipv6子网以2001:db8:a583:9::/64为例，2001:db8:a583:9::1和2001:db8:a583:9:ffff:ffff:ffff:fffd、2001:db8:a583:9:ffff:ffff:ffff:fffe、2001:db8:a583:9:ffff:ffff:ffff:ffff这些地址是系统保留地址。 系统预留地址默认不在allocation_pool范围内。 约束：更新时allocation_pool范围不能包含网关和广播地址的所有IP。 dns_nameservers Array of strings dns服务器 例如："dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] host_routes Array of host_route objects 虚拟机静态路由，参见表5 【使用说明】不支持，忽略输入信息 tenant_id String 项目ID enable_dhcp Boolean 是否启动dhcp，false表示不提供dhcp服务的能力 【使用说明】只支持true subnetpool_id String 子网池id 【使用说明】目前IPv4不支持，IPv6支持 project_id String 项目ID，请参见获取项目ID。 created_at String 资源创建时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss updated_at String 资源更新时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss 表4 allocation_pool对象 参数名 参数类型 备注 start String 网络池起始IP end String 网络池结束IP 表5 host_route对象 参数名 参数类型 备注 destination String 路由目的子网 nexthop String 路由下一跳IP 表6 subnets_link对象 参数名 参数类型 备注 href String API链接 rel String API链接与该API版本的关系

安全组规则 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 创建安全组规则 POST /v1/{project_id}/security-group-rules vpc:securityGroupRules:create √ √ 创建安全组规则（v3） POST /v3/{project_id}/vpc/security-group-rules vpc:securityGroupRules:create √ √ 查询安全组规则 GET /v1/{project_id}/security-group-rules/{rules_security_groups_id} vpc:securityGroupRules:get √ √ 查询安全组规则（v3） GET /v3/{project_id}/vpc/security-group-rules/{rules_security_groups_id} vpc:securityGroupRules:get √ √ 查询安全组规则列表 GET /v1/{project_id}/security-group-rules vpc:securityGroupRules:get √ √ 查询安全组规则列表（v3） GET /v3/{project_id}/vpc/security-group-rules vpc:securityGroupRules:get √ √ 删除安全组规则 DELETE /v1/{project_id}/security-group-rules/{rules_security_groups_id} vpc:securityGroupRules:delete √ √ 删除安全组规则（v3） DELETE /v3/{project_id}/vpc/security-group-rules/{rules_security_groups_id} vpc:securityGroupRules:delete √ √ 更新安全组规则 - vpc:securityGroupRules:update √ √ 父主题： 权限和授权项

响应示例 { "subnet": { "name": "kesmdemeet", "cidr": "172.16.236.0/24", "id": "011fc878-5521-4654-a1ad-f5b0b5820302", "enable_dhcp": true, "network_id": "48efad0c-079d-4cc8-ace0-dce35d584124", "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "dns_nameservers": [], "allocation_pools": [ { "start": "172.16.236.2", "end": "172.16.236.251" } ], "host_routes": [], "ip_version": 4, "gateway_ip": "172.16.236.1", "created_at": "2018-03-26T08:23:43", "updated_at": "2018-03-26T08:23:44" } }

响应参数 表1 响应参数 参数名称 类型 说明 subnet subnet object subnet对象，参见表2。 表2 subnet对象 属性 类型 说明 id String 子网的id 【使用说明】在查询子网列表时非必选 name String 子网的名称 ip_version Integer IP版本 【使用说明】支持4（IPv4）、6（IPv6） ipv6_address_mode String IPv6寻址模式 【使用说明】仅支持dhcpv6-stateful ipv6_ra_mode String IPv6路由广播模式 【使用说明】仅支持dhcpv6-stateful network_id String 所属网络的id cidr String CIDR格式 【使用说明】IPV4只支持10.0.0.0/8,172.16.0.0/12,192.168.0.0/16三个网段内的地址，掩码长度不能大于28。 约束:当ip_version=6时,该字段不支持设置 gateway_ip String 网关IP不允许和allocation_pools地址块冲突。 【使用说明】不支持修改。 allocation_pools Array of allocation_pool objects 可用的IP池，allocation_pool对象参见表3 例如：[ { "start": "10.0.0.2", "end": "10.0.0.251"} ] 每个子网的第1个和最后3个IP地址为系统保留地址。以192.168.1.0/24为例，192.168.1.0、 192.168.1.253、192.168.1.254和192.168.1.255这些地址是系统保留地址。 [{"start": "2001:db8:a583:9::2", "end": "2001:db8:a583:9:ffff:ffff:ffff:fffc"}] ipv6子网以2001:db8:a583:9::/64为例，2001:db8:a583:9::1和2001:db8:a583:9:ffff:ffff:ffff:fffd、2001:db8:a583:9:ffff:ffff:ffff:fffe、2001:db8:a583:9:ffff:ffff:ffff:ffff这些地址是系统保留地址。系统预留地址默认不在allocation_pool范围内。 约束：更新时allocation_pool范围不能包含网关和广播地址的所有IP。 dns_nameservers Array of strings dns服务器 例如："dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] host_routes Array of host_route objects 虚拟机静态路由，参见“host_route对象”表 【使用说明】不支持，忽略输入信息 tenant_id String 项目ID enable_dhcp Boolean 是否启动dhcp，false表示不提供dhcp服务的能力 【使用说明】只支持true subnetpool_id String 子网池id 【使用说明】目前IPv4不支持，IPv6支持 project_id String 项目ID，请参见获取项目ID。 created_at String 资源创建时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss updated_at String 资源更新时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss 表3 allocation_pool对象 参数名 参数类型 备注 start String 网络池起始IP end String 网络池结束IP 表4 host_route对象 参数名 参数类型 备注 destination String 路由目的子网 nexthop String 路由下一跳IP

响应示例 { "subnet": { "name": "subnet-test", "cidr": "172.16.2.0/24", "id": "98bac90c-0ba7-4a63-8995-097da9bead1c", "enable_dhcp": true, "network_id": "0133cd73-34d4-4d4c-bf1f-e65b24603206", "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "dns_nameservers": [], "allocation_pools": [ { "start": "172.16.2.2", "end": "172.16.2.251" } ], "host_routes": [], "ip_version": 4, "gateway_ip": "172.16.2.1", "created_at": "2018-09-20T02:02:16", "updated_at": "2018-09-20T02:03:03" } }

响应参数 表5 响应参数 参数名称 类型 说明 subnet subnet object subnet对象，参见表6。 表6 subnet对象 属性 类型 说明 id String 子网的id 【使用说明】在查询子网列表时非必选 name String 子网的名称 ip_version Integer IP版本 【使用说明】支持4（IPv4）、6（IPv6） ipv6_address_mode String IPv6寻址模式 【使用说明】仅支持dhcpv6-stateful ipv6_ra_mode String IPv6路由广播模式 【使用说明】仅支持dhcpv6-stateful network_id String 所属网络的id cidr String CIDR格式 【使用说明】IPV4只支持10.0.0.0/8,172.16.0.0/12,192.168.0.0/16三个网段内的地址，掩码长度不能大于28。 IPV6掩码长度不能大于128。 gateway_ip String 网关IP不允许和allocation_pools地址块冲突。 【使用说明】不支持修改。 allocation_pools Array of allocation_pool objects 可用的IP池，allocation_pool对象参见 表7 例如：[ { "start": "10.0.0.2", "end": "10.0.0.251"} ] 每个子网的第1个和最后3个IP地址为系统保留地址。以192.168.1.0/24为例，192.168.1.0、 192.168.1.253、192.168.1.254和192.168.1.255这些地址是系统保留地址。 [{"start": "2001:db8:a583:9::2", "end": "2001:db8:a583:9:ffff:ffff:ffff:fffc"}] ipv6子网以2001:db8:a583:9::/64为例，2001:db8:a583:9::1和2001:db8:a583:9:ffff:ffff:ffff:fffd、2001:db8:a583:9:ffff:ffff:ffff:fffe、2001:db8:a583:9:ffff:ffff:ffff:ffff这些地址是系统保留地址。 系统预留地址默认不在allocation_pool范围内。 约束：更新时allocation_pool范围不能包含网关和广播地址的所有IP。 dns_nameservers Array of strings dns服务器 例如："dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] host_routes Array of host_route objects 虚拟机静态路由，参见表8 【使用说明】不支持，忽略输入信息 tenant_id String 项目ID enable_dhcp Boolean 是否启动dhcp，false表示不提供dhcp服务的能力 【使用说明】只支持true subnetpool_id String 子网池id 【使用说明】目前IPv4不支持，IPv6支持 project_id String 项目ID，请参见获取项目ID。 created_at String 资源创建时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss updated_at String 资源更新时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss 表7 allocation_pool对象 参数名 参数类型 备注 start String 网络池起始IP end String 网络池结束IP 表8 host_route对象 参数名 参数类型 备注 destination String 路由目的子网 nexthop String 路由下一跳IP

请求参数 表1 请求参数 参数名称 类型 必选 说明 subnet subnet object 是 subnet对象，参见表2。 更新操作时至少指定一项属性 表2 subnet对象 属性 是否必选 类型 说明 name 否 String 子网的名称 allocation_pools 否 Array of allocation_pool objects 可用的IP池，allocation_pool对象参见表3 例如：[ { "start": "10.0.0.2", "end": "10.0.0.251"} ] 每个子网的第1个和最后3个IP地址为系统保留地址。以192.168.1.0/24为例，192.168.1.0、 192.168.1.253、192.168.1.254和192.168.1.255这些地址是系统保留地址。系统预留地址默认不在allocation_pool范围内。 [{"start": "2001:db8:a583:9::2", "end": "2001:db8:a583:9:ffff:ffff:ffff:fffc"}] ipv6子网以2001:db8:a583:9::/64为例，2001:db8:a583:9::1和2001:db8:a583:9:ffff:ffff:ffff:fffd、2001:db8:a583:9:ffff:ffff:ffff:fffe、2001:db8:a583:9:ffff:ffff:ffff:ffff这些地址是系统保留地址。 约束：更新时allocation_pool范围不能包含网关和广播地址的所有IP。 dns_nameservers 否 Array of strings dns服务器 【使用说明】 例如："dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] 最大为5个 host_routes 否 Array of host_route objects 虚拟机静态路由，参见表4 【使用说明】不支持，忽略输入信息 enable_dhcp 否 Boolean 是否启动dhcp，false表示不提供dhcp服务的能力 【使用说明】只支持true 表3 allocation_pool对象 参数名 是否必选 参数类型 说明 start 否 String 网络池起始IP end 否 String 网络池结束IP 表4 host_route对象 参数名 是否必选 参数类型 说明 destination 否 String 路由目的子网 nexthop 否 String 路由下一跳IP