备案 控制台 登录 注册
文档中心 > DescribeAffinities
DescribeAffinities

最近更新时间：2021-11-08

请求方法：GET

接口描述：使用DescribeAffinities获取云主机的亲和性信息。


请求参数

Param

名称

类型

是否必选

描述

Action

String

是

要执行的操作。取值DescribeAffinities

RegionId

String

是

区域Id

Page

int

否

页码，默认1

Size

int

否

列表容量，默认10

Id

String

否

id筛选条件

Name

String

否

名称筛选条件


返回参数

名称

类型

示例

描述

RequestId

String

"b9de1a62-d09e-4d34-9a61-38f0f56564b6"

请求ID

page

int

1

请求的page

size

int

10

请求的size

totalCount

int

1

总条数

totalPages

int

1

总页数

list

object[]


内容

+id

String

aff-krumxviqob1d

启动集ID

+regionId

String

cn-beijing

地区ID

+userId

String

7d0608e1-fdaa-4cdf-96fa-6bd1d0b73710

用户ID

+status

String

1

状态

  • 1：正常

  • -1：已删除

+name

String

test-affinity

名称

+description

String


描述

+createTime

Long

1594884544000

创建时间

+affinityType

String

force_non_affinity

亲和类型

  • force_non_affinity：强制非亲和

  • random_non_affinity：非强制非亲和

+maxVm

int

16

最大支持主机数

+vmIds

String[]

["ecs-krumyfnb7yyw"]

启动集内主机ID


示例

请求示例

GET https://api.unicloud.com/compute/ecs/instances?
Action=DescribeAffinities
&RegionId=cn-beijing
&Page=1
&Size=20
&公共请求参数

返回示例

JSON格式

{
   "RequestId": "b9de1a62-d09e-4d34-9a61-38f0f56564b6",
   "page": 1,
   "size": 20,
   "totalCount": 1,
   "totalPages": 1,
   "list": [
      {
           "id": "aff-krumxviqob1d",
           "regionId": "cn-beijing",
           "userId": "7d0608e1-fdaa-4cdf-96fa-6bd1d0b73710",
           "status": 1,
           "name": "dddd",
           "description": "",
           "affinityType": "force_non_affinity",
           "createTime": 1617957192000,
           "vmIds": [
               "ecs-krumyfnb7yyw"
          ],
           "maxVm": 16
      }
  ]
}