查询流量策略
接口功能介绍
查询流量策略
接口约束
无
URI
GET /v4/ec/traffic-policy/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ecID | 是 | String | 云间高速ID | 82c40584-fe8f-49b0-9e09-ef915caeee10 | |
| cgwID | 是 | String | 云网关ID | 7c84cfa9-a997-4281-af8a-3c765c25d0be | |
| instID | 否 | String | 实例ID 当实例为VPC时，为vpcID |
bc9a70eb-28d7-4032-9510-1bea00192f34 |
请求参数
请求头header参数
无
请求body参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码 取值范围: 800:成功 900:失败 |
800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| traceID | 否 | String | 链路追踪ID | 74cb2e66-1f95-45da-aac5-ee013470fd96 | |
| returnObj | 否 | Object | 返回参数 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| currentCount | 否 | Integer | 当前页记录数 | 3 | |
| totalPage | 否 | Integer | 总页数 | 1 | |
| totalCount | 否 | Integer | 查询的总记录数 | 3 | |
| results | 否 | Array of Objects | 返回查询结果，Json数组 | results |
表results
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ecID | 否 | String | 云间高速实例ID | 82c40584-fe8f-49b0-9e09-ef915caeee10 | |
| cgwID | 否 | String | 云网关ID | 7c84cfa9-a997-4281-af8a-3c765c25d0be | |
| policyID | 否 | String | 策略ID | 55450584-fe8f-49b0-9e09-ef915caeee10 | |
| policyName | 否 | String | 策略名称 | policy-93da33 | |
| displayID | 否 | String | 实例侧ID信息，例如vpcID | bc9a70eb-28d7-4032-9510-1bea00192f34 | |
| instanceID | 否 | String | 实例UUID | bc9a70eb-28d7-4032-9510-1bea00192f34 | |
| instanceName | 否 | String | 实例名称 | vpc-93da33 | |
| instanceType | 否 | Integer | 实例类型，取值范围 1: "VPC实例" |
2 | |
| isAuth | 否 | Integer | 是否是跨账号实例 取值包括： 0:本账号 1:跨账号 |
0 | |
| dcID | 否 | String | 实例所属的资源池ID | 10000000-579a-4b82-b3d6-b3d6 | |
| bandwidth | 否 | Integer | 带宽，单位KB | 1000 | |
| weights | 否 | Integer | 流量策略的权重值 | 100 | |
| policyDescription | 否 | String | 描述信息 | 1000 | |
| createDate | 否 | String | 创建时间 | 2019-08-30 16:57:47 |
请求示例
请求url
v4/ec/traffic-policy/list?ecID=82c40584-fe8f-49b0-9e09-ef915caeee10&cgwID=7c84cfa9-a997-4281-af8a-3c765c25d0be
请求头header
无
请求体body
无
响应示例
{
"description":"",
"errorCode":"",
"message":"",
"statusCode":800,
"traceID":"2062f2ab-6722-4273-9850-997b4398ddb5",
"returnObj":{
"totalCount":1,
"totalPage":1,
"currentCount":1,
"results":[
{
"ecID": "82c40584-fe8f-49b0-9e09-ef915caeee10",
"cgwID": "7c84cfa9-a997-4281-af8a-3c765c25d0be",
"policyID": "55450584-fe8f-49b0-9e09-ef915caeee10",
"policyName": "policy-93da33",
"displayID": "bc9a70eb-28d7-4032-9510-1bea00192f34",
"instanceID": "bc9a70eb-28d7-4032-9510-1bea00192f34",
"instanceName": "vpc-93da33",
"instanceType": 2,
"isAuth": 0,
"dcID": "10000000-579a-4b82-b3d6-b3d6",
"bandwidth": 1000,
"weights": 100,
"policyDescription": "示例描述",
"createDate": "2019-08-30 16:57:47"
}
]
}
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| Openapi.TrafficPolicyEc.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
