Hello, I'm trying to use the Rest API to get user/group information for a qtree. According to the docs for FileInfo: "The metadata and detailed information about a single directory or file can be retrieved by setting the return_metadata query property to true" and here's the snippet of code provided: with HostConnection( " " , username= "admin" , password= "password" , verify= False ): resource = FileInfo( "cb6b1b39-8d21-11e9-b926-05056aca658" , path= "d1/d2/d3/f1" ) resource.get(return_metadata= True ) print(resource) Now if I run that using a real volume UUID and path, I get: netapp_ontap.error.NetAppRestError: Caused by HTTPError('400 Client Error: Bad Request for url: https://abc123-mgmt:443/api/storage/volumes/60c2a6c2-25f2-11eb-87c4-000c29e6051b/files/test_1?return_metadata=True '): Unexpected argument "return_metadata". and sure enough, if I try and put that URL into a browser (after passing in credentials): message "Unexpected argument \"return_metadata\"." So am I doing something wrong, are the docs wrong? thx, --rdp

nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

FileInfo & return_metadata=True

richard_payne

Hello,

I'm trying to use the Rest API to get user/group information for a qtree. According to the docs for FileInfo:

"The metadata and detailed information about a single directory or file can be retrieved by setting the return_metadata query property to true"

</code></p><p>and here's the snippet of code provided:<code>

<span class="hljs-keyword">with</span> HostConnection(<span class="hljs-string">"<mgmt-ip>"</span>, username=<span class="hljs-string">"admin"</span>, password=<span class="hljs-string">"password"</span>, verify=<span class="hljs-keyword">False</span>):
    resource = FileInfo(<span class="hljs-string">"cb6b1b39-8d21-11e9-b926-05056aca658"</span>, path=<span class="hljs-string">"d1/d2/d3/f1"</span>)
    resource.get(return_metadata=<span class="hljs-keyword">True</span>)
    print(resource)

</code>Now if I run that using a real volume UUID and path, I get:</p><p>netapp_ontap.error.NetAppRestError: Caused by HTTPError('400 Client Error: Bad Request for url: <a href="https://abc123-mgmt:443/api/storage/volumes/60c2a6c2-25f2-11eb-87c4-000c29e6051b/files/test_1?return_metadata=True" target="_blank" rel="nofollow noopener noreferrer">https://abc123-mgmt:443/api/storage/volumes/60c2a6c2-25f2-11eb-87c4-000c29e6051b/files/test_1?return_metadata=True</a>'): Unexpected argument "return_metadata".</p><p>and sure enough,  if I try and put that URL into a browser (after passing in credentials):</p><table class="treeTable" tabindex="0" role="tree" cellspacing="0" cellpadding="0" aria-label="" aria-activedescendant="/error/message"><tbody tabindex="-1" role="presentation"><tr id="/error/message" class="treeRow stringRow opened selected" role="treeitem" aria-level="2" aria-selected="true"><td class="treeLabelCell" style="--tree-label-cell-indent: 16px;"><span class="treeLabel stringLabel" aria-labelledby="default" data-level="1">message</span></td><td class="treeValueCell stringCell"><span aria-labelledby="value"><span class="objectBox objectBox-string">"Unexpected argument \"return_metadata\"."</span></span></td></tr></tbody></table><p><code>

So am I doing something wrong, are the docs wrong?

</code></p><p>thx,</p><p>--rdp<code>

Find more posts tagged with

ONTAP REST APIs

Accepted answers

RobertBlackhart

I took a look, I think it requires at least 9.7P6 which might explain the difference for you if your simulator is on something earlier than that.

All comments

RobertBlackhart

What version of ONTAP are you running? This does seem to work for me on 9.7:

>>> from netapp_ontap import HostConnection
>>> from netapp_ontap.resources import FileInfo
>>> with HostConnection("<mgmt_ip>", "<username>", "<password>", verify=False):
  2     resource = FileInfo('b8e7dae7-242d-11eb-9046-005056bbcad1', path="file1")
  3     resource.get(return_metadata=True)
>>> resource
FileInfo({'type': 'file', 'changed_time': '2020-11-16T16:32:26-05:00', 'hard_links_count': 1, 'is_vm_aligned': False, 'accessed_time': '2020-11-16T16:32:26-05:00', 'owner_id': 0, 'fill_enabled': False, 'overwrite_enabled': False, 'size': 15, 'is_snapshot': False, 'path': 'file1', 'unique_bytes': 0, 'creation_time': '2020-11-16T16:32:26-05:00', 'inode_number': 96, 'modified_time': '2020-11-16T16:32:26-05:00', 'unix_permissions': 644, 'inode_generation': 42865720, 'group_id': 0, 'is_junction': False, 'bytes_used': 0})

>>>

richard_payne

I am running:

NetApp Release 9.7: Thu Jan 09 11:10:19 UTC 2020

However, that's a simulator. I just tried running against physical hardware (9.7P8) and that appears to work. So for some reason the SIM 9.7 isn't really 9.7, or this requires a particular P release?

thx,

--rdp

RobertBlackhart

I took a look, I think it requires at least 9.7P6 which might explain the difference for you if your simulator is on something earlier than that.

richard_payne

Thanks, that was it. I updated the SIM to 9.7P8 this morning and now the call is working.

--rdp

richard_payne

I may have jumped the gun on the solved part. If I pull up the URL via the management interface of the cluster with the API call then I get the file information (in this case the metadata of the qtree itself). However, when I do the same from python I just get the "_links" section back. I've stripped the test case back to this (based on your code and the docs):

#!/usr/bin/python3

from netapp_ontap import HostConnection

from netapp_ontap.resources import FileInfo

with HostConnection("<ip_addr>", "<user>", "<password>", verify=False😞

resource = FileInfo("60c2a6c2-25f2-11eb-87c4-000c29e6051b", path="rdp_test_1")

resource.get(return_metadata=True)

print (resource)

but what I'm getting back is just:

FileInfo({'_links': {'self': {'href': '/api/storage/volumes/60c2a6c2-25f2-11eb-87c4-000c29e6051b/files/rdp_test_1?return_metadata=True'}}})

Again, if I paste that URL into the browser on the managment interface (same username/password) it works fine. Tested on both the SIM and a real physical cluster.