GET /api/locations
List all locations

参数

参数名字 描述
location_id
选填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
选填

Set the current organization context for the request

Validations:

  • Must be a Integer

search
选填

过滤结果

Validations:

  • Must be a String

order
选填

排序项和顺序,例如 ‘id DESC’

Validations:

  • Must be a String

page
选填

页号,从 1 开始

Validations:

  • Must be a number.

per_page
选填

每页中显示的返回结果数

Validations:

  • Must be a number.

搜索字段

字段名 类型 可能的值
description
id
location_id
name
title

GET /api/locations/:id
Show a location

参数

参数名字 描述
location_id
选填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
选填

Set the current organization context for the request

Validations:

  • Must be a Integer

show_hidden_parameters
选填

显示隐藏的参数值

Validations:

  • Must be one of: true, false, 1, 0.

id
必填

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/locations
Create a location

参数

参数名字 描述
location_id
选填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
选填

Set the current organization context for the request

Validations:

  • Must be a Integer

location
必填

Validations:

  • Must be a Hash

location[name]
必填

Validations:

  • Must be a String

location[description]
选填 , 允许空值

Validations:

  • Must be a String

location[user_ids]
选填 , 允许空值

用户 ID

Validations:

  • Must be an array of any type

location[smart_proxy_ids]
选填 , 允许空值

智能代理服务器 ID

Validations:

  • Must be an array of any type

location[compute_resource_ids]
选填 , 允许空值

计算资源 ID

Validations:

  • Must be an array of any type

location[medium_ids]
选填 , 允许空值

介质 ID

Validations:

  • Must be an array of any type

location[ptable_ids]
选填 , 允许空值

分区模板 ID

Validations:

  • Must be an array of any type

location[provisioning_template_ids]
选填 , 允许空值

预配模板 ID

Validations:

  • Must be an array of any type

location[domain_ids]
选填 , 允许空值

域 ID

Validations:

  • Must be an array of any type

location[realm_ids]
选填 , 允许空值

范围 ID

Validations:

  • Must be an array of any type

location[hostgroup_ids]
选填 , 允许空值

主机组 ID

Validations:

  • Must be an array of any type

location[environment_ids]
选填 , 允许空值

环境 ID

Validations:

  • Must be an array of any type

location[subnet_ids]
选填 , 允许空值

子网 ID

Validations:

  • Must be an array of any type

location[parent_id]
选填 , 允许空值

父 ID

Validations:

  • Must be a number.

location[ignore_types]
选填 , 允许空值

将会自动关联的资源类型列表

Validations:

  • Must be an array of any type

location[organization_ids]
选填 , 允许空值

Associated organization IDs

Validations:

  • Must be an array of any type


PUT /api/locations/:id
Update a location

参数

参数名字 描述
location_id
选填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
选填

Set the current organization context for the request

Validations:

  • Must be a Integer

location
必填

Validations:

  • Must be a Hash

location[name]
选填

Validations:

  • Must be a String

location[description]
选填 , 允许空值

Validations:

  • Must be a String

location[user_ids]
选填 , 允许空值

用户 ID

Validations:

  • Must be an array of any type

location[smart_proxy_ids]
选填 , 允许空值

智能代理服务器 ID

Validations:

  • Must be an array of any type

location[compute_resource_ids]
选填 , 允许空值

计算资源 ID

Validations:

  • Must be an array of any type

location[medium_ids]
选填 , 允许空值

介质 ID

Validations:

  • Must be an array of any type

location[ptable_ids]
选填 , 允许空值

分区模板 ID

Validations:

  • Must be an array of any type

location[provisioning_template_ids]
选填 , 允许空值

预配模板 ID

Validations:

  • Must be an array of any type

location[domain_ids]
选填 , 允许空值

域 ID

Validations:

  • Must be an array of any type

location[realm_ids]
选填 , 允许空值

范围 ID

Validations:

  • Must be an array of any type

location[hostgroup_ids]
选填 , 允许空值

主机组 ID

Validations:

  • Must be an array of any type

location[environment_ids]
选填 , 允许空值

环境 ID

Validations:

  • Must be an array of any type

location[subnet_ids]
选填 , 允许空值

子网 ID

Validations:

  • Must be an array of any type

location[parent_id]
选填 , 允许空值

父 ID

Validations:

  • Must be a number.

location[ignore_types]
选填 , 允许空值

将会自动关联的资源类型列表

Validations:

  • Must be an array of any type

location[organization_ids]
选填 , 允许空值

Associated organization IDs

Validations:

  • Must be an array of any type

id
必填

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


DELETE /api/locations/:id
Delete a location

参数

参数名字 描述
location_id
选填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
选填

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必填

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.