安置组列表
安置组列表
1. 描述
获取可用安置组列表
2. 请求地址
请求地址的格式如下：
https://<区域服务地址>/v1/pg/list
3. 请求参数
| Name | Type | Description | Required |
|---|---|---|---|
| projectId | String | 所属项目ID | 是 |
| azSn | String | azSn | 否 |
| nameOrSn | String | 名称或SN | 否 |
| curPage | Integer | 当前页码，默认值1 | 否 |
| perPage | Integer | 每页显示条数，默认值10 | 否 |
4. 请求示例
4.1. 请求地址
POST https://cn-east-1.api.yovole.com/v1/pg/list HTTP/1.1
x-ycs-timestamp: 2019-06-19T14:26:26Z
x-ycs-requestid: 2a49cfa2-925b-11e9-bb3a-6c96cfdcd6b9
x-ycs-security-authorization: Authorization: YCS1-HMAC-SHA1 Credential=08e206fb-7b41-45b7-8076-8d43e8aeea89,SignedHeaders=content-type;x-ycs-requestid;x-ycs-timestamp,Signature=2RFjU7C9gICCrQfpAIfAJHqRRlQ=
4.2. 接口请求参数
{
"projectId": "8a83a0966a681da5016a874df50b10ce",
"azSN": "CN-EAST-1-A",
"curPage":1,
"perPage":10
}
5. 返回结果
5.1. 返回正确结果示例
{
"requestId":"80af1bdf-9e39-4d29-b88e-0fba17a7783a",
"success":true,
"code":200,
"pager":{
"curPage":1,
"perPage":10,
"totalRecords":2,
"totalPages":1,
"pageData":[
{
"id":"f675d4bb-1755-4b43-a142-9f1a9d2800e5",
"name":"分散安置组",
"sn":"PG-210003U",
"regionSn":"CN-EAST-1",
"created":"2019-06-06 17:24:38",
"desc":"分散",
"policy":"disperse",
"serverCount":1
},
{
"id":"ab6fba9a-7bcf-4dcf-8241-525d97045567",
"name":"TEST",
"sn":"PG-21B-0003T",
"regionSn":"CN-EAST-1",
"azSn":"az2",
"created":"2019-06-06 16:15:52",
"desc":"test",
"policy":"affinity",
"serverCount":0
}
]
}
}
5.2. 返回错误结果示例
{
"requestId": "2a49cfa2-925b-11e9-bb3a-6c96cfdcd6b9",
"success": false,
"code": 400,
"message": "Required attribute 'projectId' not specified",
"errorCode": "Invalid argument"
}
6. 错误码
可以通过错误返回结果中的code、errorCode和message字段了解错误分类和具体的错误原因。
该接口没有特殊错误码，错误码信息和简单的错误分析方法可以参考公共错误码。