일부 요청은 반환되거나 작동되는 데이터를 선택할 질의 매개변수(선택사항)를 사용할 수 있습니다. 이 절에서는 둘 이상의 리소스 유형에 사용 가능한 질의 매개변수를 문서화합니다. 해당 리소스와 관련된 질의 매개변수 및 이 절에서 설명되는 질의 매개변수의 특별한 용도는 각 리소스의 설명서를 참조하십시오.
|
props 질의 매개변수는 등록 정보 메타데이터 값을 보여줍니다. 데이터를 변경하거나 새 데이터를 만들 작업에서 props=true를 사용하면 등록 정보 및 메타데이터가 표시되고 작업이 수행되지 않습니다. 이를 통해 리소스 수정 또는 생성에 유용한 현재 데이터 값을 표시할 수 있습니다.
|
start 질의 매개변수는 객체 인덱스 번호 또는 시간일 수 있습니다.
해당 인덱스가 선택한 객체 및 지정된 객체가 만들어진 후 만들어진 가장 오래된 객체를 포함하는 목록을 반환할 객체 인덱스 번호를 지정합니다.
가장 오래된 객체 또는 지정된 시간 또는 그 이후에 만들어진 데이터 목록을 반환할 UTC 시간을 지정합니다. 일부 리소스는 start 질의 매개변수에 대한 시간 값을 지원하지 않습니다.
시간 값은 다음 표에 나타난 형식의 UTC 시간으로 표시되어야 합니다.
|
start 질의 매개변수를 사용하는 예는 다음 절을 참조하십시오.
end 질의 매개변수는 객체 인덱스 번호 또는 시간일 수 있습니다.
해당 인덱스가 선택한 객체 및 지정된 객체가 만들어지기 전 만들어진 최신 객체를 포함하는 목록을 반환할 객체 인덱스 번호를 지정합니다.
최신 객체 또는 지정된 시간 또는 그 이전에 만들어진 데이터 목록을 반환할 UTC 시간을 지정합니다.
시간 값은 %Y-%m-%dT%H:%M:%SZ 형식의 UTC 시간으로 표시되어야 합니다.
end 질의 매개변수 사용 예는 클라우드 백업 나열을 참조하십시오.
limit 질의 매개변수는 반환할 최대 요소 수를 지정합니다.
start와 end도 지정되지 않은 경우 limit=n은 가장 최근 n개 요소를 반환합니다.
depth 질의 매개변수는 반환된 리소스 목록에 대한 세부정보 레벨을 지정합니다. depth 값이 클수록 아래 표에서와 같이 세부정보가 더 많이 반환됩니다.
|
질의 매개변수 depth를 통한 사용자 목록에 대한 요청 예:
GET /api/user/v1/users?depth=2 HTTP/1.1 Host: zfs-storage.example.com:215 X-Auth-User: root X-Auth-Key: password-xxx
응답 예:
간략히 나타내기 위해 추가 사용자는 생략됩니다.
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1558
X-Zfssa-Access-Api: 1.0
{
"users": [
{
"name": "root",
...
},
{
"name": "firstlast",
"properties": {
"logname": "firstlast",
"type": "directory",
"uid": uid,
"fullname": "First Last",
"require_annotation": false,
"roles": [
"basic"
],
"kiosk_mode": false,
"kiosk_screen": "status/dashboard"
},
"children": [
{
"name": "exceptions",
"properties": {},
"children": [],
"list": [
{
"name": "auth-000",
"properties": {
"scope": "ad",
"name": "*",
"allow_domain": true,
"allow_workgroup": false
},
"children": [],
"list": []
},
{
"name": "auth-001",
"properties": {
"scope": "alert",
"allow_configure": true,
"allow_post": true
},
"children": [],
"list": []
}
]
},
{
"name": "preferences",
"properties": {
"locale": "C",
"login_screen": "configuration/preferences",
"session_timeout": 15,
"cli_idle_timeout": "infinite",
"advanced_analytics": false
},
"children": [
{
"name": "keys",
"properties": {},
"children": [],
"list": []
},
{
"name": "tokens",
"properties": {},
"children": [],
"list": []
}
],
"list": []
}
],
"list": [],
"href": "/api/user/v1/users/firstlast"
},
{
...
}
]
}
matchproperty-name=value 질의 매개변수는 지정된 값의 지정된 등록 정보 이름이 있는 리소스 목록을 반환합니다.
다음 예에서는 kiosk_mode 등록 정보의 값이 true인 사용자 목록을 반환합니다.
match_kiosk_mode=true
다음 예에서는 roles 등록 정보의 값에 super가 포함되고 require_annotation 등록 정보의 값이 true인 사용자 목록을 반환합니다.
match_roles='*super*'&match_require_annotation=true