私有网络查询协议端口-私有网络 API 2017-API 中心-腾讯云

1. 接口描述
本接口（DescribeService）用于查询(网络)参数模板协议端口列表。
接口请求域名：vpc.api.qcloud.com
2. 输入参数
以下请求参数列表仅列出了接口请求参数，正式调用时需要加上公共请求参数，见公共请求参数页面。其中，此接口的 Action 字段为 DescribeService。
参数名称
必选
类型
描述
 serviceId 
 否 
 String 
协议端口 ID，支持模糊搜索。
 serviceName 
 否 
 String 
 协议端口名称，支持模糊搜索。
 offset 
 否 
 Int 
 初始行的偏移量，默认为0。
 limit 
 否 
 Int 
 每页行数，默认为20。
﻿
注：serviceId 和 serviceName 作为查询条件为逻辑与关系。
3. 输出参数
参数名称
类型
描述
code
Int
数字错误码, 0 表示成功，其他值表示失败。详见错误码页面的 公共错误码。
message
String
错误信息。
codeDesc
String
英文错误码。
data
Object
返回的数据结构。
data结构
参数名称
类型
描述
data.totalCount
Int
返回的协议端口总数。
data.data
Array
返回的协议端口详情列表。
data.data 结构
参数名称
类型
描述
 data.n.serviceId 
 String 
 协议端口 ID
 data.n.serviceName 
 String 
 协议端口名称
 data.n.service 
 Array 
 协议端口成员
 data.n.createTime 
 String 
 创建时间
data.n.service 结构
参数名称
类型
描述
 data.n.service.n 
 String 
 协议端口成员
4. 错误码表
错误码数值
原因
 29257 
 后台错误，请求失败。
 29258 
 引用资源不存在。
 29259 
 关联对象因规则展开过大拒绝您的关联。
 29260 
 参数模板总数或成员数使用超限。
 29254 
 鉴权失败。
 9003 
 参数错误。
 9005 
 系统忙或有相关资源正在被编辑。
5. 示例
输入
https://vpc.api.qcloud.com/v2/index.php?Action=DescribeService
  &<公共请求参数>
  &serviceId=ppm
输出
{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": {
        "totalCount": 1,
        "data": [
            {
                "serviceId": "ppm-faxxv5v5",
                "serviceName": "test",
                "service": [
                    "tcp:90-99"
                ],
                "createTime": "2017-07-11 14:58:04"
            }
        ]
    }
}
﻿

参数名称	必选	类型	描述
serviceId	否	String	协议端口 ID，支持模糊搜索。
serviceName	否	String	协议端口名称，支持模糊搜索。
offset	否	Int	初始行的偏移量，默认为0。
limit	否	Int	每页行数，默认为20。

错误码数值	原因
29257	后台错误，请求失败。
29258	引用资源不存在。
29259	关联对象因规则展开过大拒绝您的关联。
29260	参数模板总数或成员数使用超限。
29254	鉴权失败。
9003	参数错误。
9005	系统忙或有相关资源正在被编辑。

查询协议端口

本页目录：

1. 接口描述

2. 输入参数

3. 输出参数

4. 错误码表

5. 示例