"use strict";(self.webpackChunkelementary_public_docs=self.webpackChunkelementary_public_docs||[]).push([[69821],{15680:(e,t,n)=>{n.d(t,{xA:()=>y,yg:()=>d});var a=n(96540);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function g(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?l(Object(n),!0).forEach((function(t){r(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):l(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function i(e,t){if(null==e)return{};var n,a,r=function(e,t){if(null==e)return{};var n,a,r={},l=Object.keys(e);for(a=0;a<l.length;a++)n=l[a],t.indexOf(n)>=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a<l.length;a++)n=l[a],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),o=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):g(g({},t),e)),n},y=function(e){var t=o(e.components);return a.createElement(p.Provider,{value:t},e.children)},s="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,l=e.originalType,p=e.parentName,y=i(e,["components","mdxType","originalType","parentName"]),s=o(n),m=r,d=s["".concat(p,".").concat(m)]||s[m]||u[m]||l;return n?a.createElement(d,g(g({ref:t},y),{},{components:n})):a.createElement(d,g({ref:t},y))}));function d(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=n.length,g=new Array(l);g[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:r,g[1]=i;for(var o=2;o<l;o++)g[o]=n[o];return a.createElement.apply(null,g)}return a.createElement.apply(null,n)}m.displayName="MDXCreateElement"},9076:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>g,default:()=>u,frontMatter:()=>l,metadata:()=>i,toc:()=>o});var a=n(58168),r=(n(96540),n(15680));const l={sidebar_position:2,title:"\u67e5\u8be2\u6587\u4ef6\u5217\u8868"},g="\u67e5\u8be2\u6587\u4ef6\u5217\u8868",i={unversionedId:"model-as-a-service/nova/file/GetFileList",id:"model-as-a-service/nova/file/GetFileList",title:"\u67e5\u8be2\u6587\u4ef6\u5217\u8868",description:"\u63a5\u53e3\u63cf\u8ff0\uff08Description\uff09",source:"@site/docs/model-as-a-service/nova/file/GetFileList.md",sourceDirName:"model-as-a-service/nova/file",slug:"/model-as-a-service/nova/file/GetFileList",permalink:"/help/docs/model-as-a-service/nova/file/GetFileList",draft:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/model-as-a-service/nova/file/GetFileList.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{sidebar_position:2,title:"\u67e5\u8be2\u6587\u4ef6\u5217\u8868"},sidebar:"tutorialSidebar",previous:{title:"\u521b\u5efa\u5e76\u4e0a\u4f20\u6587\u4ef6",permalink:"/help/docs/model-as-a-service/nova/file/CreateFile"},next:{title:"\u67e5\u8be2\u6587\u4ef6\u8be6\u60c5",permalink:"/help/docs/model-as-a-service/nova/file/GetFileDetail"}},p={},o=[{value:"<strong>\u63a5\u53e3\u63cf\u8ff0\uff08Description\uff09</strong>",id:"\u63a5\u53e3\u63cf\u8ff0description",level:3},{value:"<strong>\u8bf7\u6c42\u5730\u5740\uff08Request URL\uff09</strong>",id:"\u8bf7\u6c42\u5730\u5740request-url",level:3},{value:"<strong>\u8bf7\u6c42\u5934\uff08Request Header\uff09</strong>",id:"\u8bf7\u6c42\u5934request-header",level:3},{value:"<strong>\u8bf7\u6c42\u53c2\u6570\uff08Query Parameters\uff09</strong>",id:"\u8bf7\u6c42\u53c2\u6570query-parameters",level:3},{value:"<strong>\u8bf7\u6c42\u793a\u4f8b\uff08Request Example\uff09</strong>",id:"\u8bf7\u6c42\u793a\u4f8brequest-example",level:3},{value:"<strong>\u54cd\u5e94\uff08Response\uff09</strong>",id:"\u54cd\u5e94response",level:3},{value:"<strong>\u54cd\u5e94\u793a\u4f8b\uff08Response Example\uff09</strong>",id:"\u54cd\u5e94\u793a\u4f8bresponse-example",level:3},{value:"<strong>\u9519\u8bef\u4fe1\u606f</strong>",id:"\u9519\u8bef\u4fe1\u606f",level:3}],y={toc:o},s="wrapper";function u(e){let{components:t,...n}=e;return(0,r.yg)(s,(0,a.A)({},y,n,{components:t,mdxType:"MDXLayout"}),(0,r.yg)("h1",{id:"\u67e5\u8be2\u6587\u4ef6\u5217\u8868"},"\u67e5\u8be2\u6587\u4ef6\u5217\u8868"),(0,r.yg)("h3",{id:"\u63a5\u53e3\u63cf\u8ff0description"},(0,r.yg)("strong",{parentName:"h3"},"\u63a5\u53e3\u63cf\u8ff0\uff08Description\uff09")),(0,r.yg)("p",null,"\u67e5\u8be2\u6587\u4ef6\u5217\u8868"),(0,r.yg)("br",null),(0,r.yg)("h3",{id:"\u8bf7\u6c42\u5730\u5740request-url"},(0,r.yg)("strong",{parentName:"h3"},"\u8bf7\u6c42\u5730\u5740\uff08Request URL\uff09")),(0,r.yg)("pre",null,(0,r.yg)("code",{parentName:"pre"},"[GET] https://file.sensenova.cn/v1/files\n")),(0,r.yg)("br",null),(0,r.yg)("h3",{id:"\u8bf7\u6c42\u5934request-header"},(0,r.yg)("strong",{parentName:"h3"},"\u8bf7\u6c42\u5934\uff08Request Header\uff09")),(0,r.yg)("p",null,"\u65e0\u7279\u6b8aHeader\uff0c\u8bf7\u53c2\u8003",(0,r.yg)("a",{parentName:"p",href:"/help/docs/model-as-a-service/nova/overview/Authorization"},"\u63a5\u53e3\u9274\u6743")),(0,r.yg)("br",null),(0,r.yg)("h3",{id:"\u8bf7\u6c42\u53c2\u6570query-parameters"},(0,r.yg)("strong",{parentName:"h3"},"\u8bf7\u6c42\u53c2\u6570\uff08Query Parameters\uff09")),(0,r.yg)("table",null,(0,r.yg)("thead",{parentName:"table"},(0,r.yg)("tr",{parentName:"thead"},(0,r.yg)("th",{parentName:"tr",align:null},"\u540d\u79f0"),(0,r.yg)("th",{parentName:"tr",align:null},"\u7c7b\u578b"),(0,r.yg)("th",{parentName:"tr",align:null},"\u5fc5\u987b"),(0,r.yg)("th",{parentName:"tr",align:null},"\u9ed8\u8ba4\u503c"),(0,r.yg)("th",{parentName:"tr",align:null},"\u53ef\u9009\u503c"),(0,r.yg)("th",{parentName:"tr",align:null},"\u63cf\u8ff0"))),(0,r.yg)("tbody",{parentName:"table"},(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},"paging.offset"),(0,r.yg)("td",{parentName:"tr",align:null},"int"),(0,r.yg)("td",{parentName:"tr",align:null},"\u5426"),(0,r.yg)("td",{parentName:"tr",align:null},"0"),(0,r.yg)("td",{parentName:"tr",align:null},"-"),(0,r.yg)("td",{parentName:"tr",align:null},"\u5206\u9875\u53c2\u6570\uff0c\u4ece\u5217\u8868\u7684\u7b2c\u51e0\u6761\u5f00\u59cb\u83b7\u53d6")),(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},"paging.limit"),(0,r.yg)("td",{parentName:"tr",align:null},"int"),(0,r.yg)("td",{parentName:"tr",align:null},"\u5426"),(0,r.yg)("td",{parentName:"tr",align:null},"50"),(0,r.yg)("td",{parentName:"tr",align:null},"-"),(0,r.yg)("td",{parentName:"tr",align:null},"\u5206\u9875\u53c2\u6570\uff0c\u6bcf\u9875\u8fd4\u56de\u7ed3\u679c\u7684\u6570\u91cf\u9650\u5236")))),(0,r.yg)("br",null),(0,r.yg)("h3",{id:"\u8bf7\u6c42\u793a\u4f8brequest-example"},(0,r.yg)("strong",{parentName:"h3"},"\u8bf7\u6c42\u793a\u4f8b\uff08Request Example\uff09")),(0,r.yg)("pre",null,(0,r.yg)("code",{parentName:"pre",className:"language-bash"},'curl --request GET "https://file.sensenova.cn/v1/files" \\\n  -H "Content-Type: application/json" \\\n  -H "Authorization: Bearer $API_TOKEN" \n')),(0,r.yg)("br",null),(0,r.yg)("h3",{id:"\u54cd\u5e94response"},(0,r.yg)("strong",{parentName:"h3"},"\u54cd\u5e94\uff08Response\uff09")),(0,r.yg)("table",null,(0,r.yg)("thead",{parentName:"table"},(0,r.yg)("tr",{parentName:"thead"},(0,r.yg)("th",{parentName:"tr",align:null},"\u540d\u79f0"),(0,r.yg)("th",{parentName:"tr",align:null},"\u7c7b\u578b"),(0,r.yg)("th",{parentName:"tr",align:null},"\u63cf\u8ff0"))),(0,r.yg)("tbody",{parentName:"table"},(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},"files"),(0,r.yg)("td",{parentName:"tr",align:null},"object[]"),(0,r.yg)("td",{parentName:"tr",align:null},"\u6587\u4ef6\u5217\u8868")),(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},"paging"),(0,r.yg)("td",{parentName:"tr",align:null},"object"),(0,r.yg)("td",{parentName:"tr",align:null},"\u5206\u9875\u4fe1\u606f")))),(0,r.yg)("ul",null,(0,r.yg)("li",{parentName:"ul"},"\u5176\u4e2d\uff0c",(0,r.yg)("inlineCode",{parentName:"li"},"files")," \u90e8\u5206\u53c2\u6570\u5982\u4e0b\uff1a")),(0,r.yg)("table",null,(0,r.yg)("thead",{parentName:"table"},(0,r.yg)("tr",{parentName:"thead"},(0,r.yg)("th",{parentName:"tr",align:null},"\u540d\u79f0"),(0,r.yg)("th",{parentName:"tr",align:null},"\u7c7b\u578b"),(0,r.yg)("th",{parentName:"tr",align:null},"\u63cf\u8ff0"))),(0,r.yg)("tbody",{parentName:"table"},(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},"id"),(0,r.yg)("td",{parentName:"tr",align:null},"string"),(0,r.yg)("td",{parentName:"tr",align:null},"\u6587\u4ef6ID")),(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},"description"),(0,r.yg)("td",{parentName:"tr",align:null},"string"),(0,r.yg)("td",{parentName:"tr",align:null},"\u6587\u4ef6\u63cf\u8ff0")),(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},"scheme"),(0,r.yg)("td",{parentName:"tr",align:null},"string"),(0,r.yg)("td",{parentName:"tr",align:null},"\u6587\u4ef6\u683c\u5f0f")),(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},"created_at"),(0,r.yg)("td",{parentName:"tr",align:null},"string"),(0,r.yg)("td",{parentName:"tr",align:null},"\u6587\u4ef6\u521b\u5efa\u65f6\u95f4\uff0cISO 8601\u6807\u51c6\u65f6\u95f4\u683c\u5f0f\uff0c\u7cbe\u786e\u5230\u7eb3\u79d2")),(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},"updated_at"),(0,r.yg)("td",{parentName:"tr",align:null},"string"),(0,r.yg)("td",{parentName:"tr",align:null},"\u6587\u4ef6\u66f4\u65b0\u65f6\u95f4\uff0cISO 8601\u6807\u51c6\u65f6\u95f4\u683c\u5f0f\uff0c\u7cbe\u786e\u5230\u7eb3\u79d2")),(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},"status"),(0,r.yg)("td",{parentName:"tr",align:null},"string"),(0,r.yg)("td",{parentName:"tr",align:null},"\u6587\u4ef6\u72b6\u6001\uff0c\u679a\u4e3e\u503c ",(0,r.yg)("br",null)," \u672a\u4e0a\u4f20/\u4e0a\u4f20\u4e2d\uff1a",(0,r.yg)("inlineCode",{parentName:"td"},"NOTUPLOADED")," ",(0,r.yg)("br",null)," \u5df2\u4e0a\u4f20\uff08\u7b49\u5f85\u683c\u5f0f\u6821\u9a8c\uff09\uff1a",(0,r.yg)("inlineCode",{parentName:"td"},"UPLOADED")," ",(0,r.yg)("br",null)," \u6587\u4ef6\u65e0\u6548\uff08\u683c\u5f0f\u6821\u9a8c\u4e0d\u901a\u8fc7\uff09\uff1a",(0,r.yg)("inlineCode",{parentName:"td"},"INVALID")," ",(0,r.yg)("br",null)," \u6587\u4ef6\u6709\u6548\uff08\u683c\u5f0f\u6821\u9a8c\u901a\u8fc7\uff09\uff1a",(0,r.yg)("inlineCode",{parentName:"td"},"VALID"))),(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},"file_name"),(0,r.yg)("td",{parentName:"tr",align:null},"string"),(0,r.yg)("td",{parentName:"tr",align:null},"\u6587\u4ef6\u540d\u79f0")),(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},"validate_result"),(0,r.yg)("td",{parentName:"tr",align:null},"string"),(0,r.yg)("td",{parentName:"tr",align:null},"\u6587\u4ef6\u6821\u9a8c\u7ed3\u679c")))),(0,r.yg)("ul",null,(0,r.yg)("li",{parentName:"ul"},"\u5176\u4e2d\uff0c",(0,r.yg)("inlineCode",{parentName:"li"},"paging")," \u90e8\u5206\u53c2\u6570\u5982\u4e0b\uff1a")),(0,r.yg)("table",null,(0,r.yg)("thead",{parentName:"table"},(0,r.yg)("tr",{parentName:"thead"},(0,r.yg)("th",{parentName:"tr",align:null},"\u540d\u79f0"),(0,r.yg)("th",{parentName:"tr",align:null},"\u7c7b\u578b"),(0,r.yg)("th",{parentName:"tr",align:null},"\u63cf\u8ff0"))),(0,r.yg)("tbody",{parentName:"table"},(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},"offset"),(0,r.yg)("td",{parentName:"tr",align:null},"int"),(0,r.yg)("td",{parentName:"tr",align:null},"\u5206\u9875\u53c2\u6570\uff0c\u4ece\u5217\u8868\u7684\u7b2c\u51e0\u6761\u5f00\u59cb\u83b7\u53d6")),(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},"limit"),(0,r.yg)("td",{parentName:"tr",align:null},"int"),(0,r.yg)("td",{parentName:"tr",align:null},"\u5206\u9875\u53c2\u6570\uff0c\u6bcf\u9875\u8fd4\u56de\u7ed3\u679c\u7684\u6570\u91cf\u9650\u5236")),(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},"total"),(0,r.yg)("td",{parentName:"tr",align:null},"int"),(0,r.yg)("td",{parentName:"tr",align:null},"\u5206\u9875\u53c2\u6570\uff0c\u5217\u8868\u603b\u6761\u6570")))),(0,r.yg)("br",null),(0,r.yg)("h3",{id:"\u54cd\u5e94\u793a\u4f8bresponse-example"},(0,r.yg)("strong",{parentName:"h3"},"\u54cd\u5e94\u793a\u4f8b\uff08Response Example\uff09")),(0,r.yg)("pre",null,(0,r.yg)("code",{parentName:"pre",className:"language-json"},'{\n  "files":[\n    {\n      "id": "string", \n      "description": "string",\n      "scheme": "string",\n      "created_at": "2023-06-28T17:23:01.243566533Z", \n      "updated_at": "2023-06-28T17:23:01.243566533Z",\n      "status": "string", \n      "file_name": "string",\n      "validate_result": "string"\n    }\n  ],\n  "paging": {\n    "limit": 0,\n    "offset": 0,\n    "total": 0\n  }\n}\n')),(0,r.yg)("br",null),(0,r.yg)("h3",{id:"\u9519\u8bef\u4fe1\u606f"},(0,r.yg)("strong",{parentName:"h3"},"\u9519\u8bef\u4fe1\u606f")),(0,r.yg)("p",null,"\u53c2\u8003",(0,r.yg)("a",{parentName:"p",href:"/help/docs/model-as-a-service/nova/overview/ErrorCode"},"\u9519\u8bef\u7801")))}u.isMDXComponent=!0}}]);