"use strict";(self.webpackChunkelementary_public_docs=self.webpackChunkelementary_public_docs||[]).push([[28900],{15680:(e,t,n)=>{n.d(t,{xA:()=>o,yg:()=>d});var r=n(96540);function a(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 r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var g=r.createContext({}),c=function(e){var t=r.useContext(g),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},o=function(e){var t=c(e.components);return r.createElement(g.Provider,{value:t},e.children)},p="mdxType",y={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,l=e.originalType,g=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),p=c(n),u=a,d=p["".concat(g,".").concat(u)]||p[u]||y[u]||l;return n?r.createElement(d,i(i({ref:t},o),{},{components:n})):r.createElement(d,i({ref:t},o))}));function d(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=n.length,i=new Array(l);i[0]=u;var s={};for(var g in t)hasOwnProperty.call(t,g)&&(s[g]=t[g]);s.originalType=e,s[p]="string"==typeof e?e:a,i[1]=s;for(var c=2;c{n.r(t),n.d(t,{assets:()=>g,contentTitle:()=>i,default:()=>y,frontMatter:()=>l,metadata:()=>s,toc:()=>c});var r=n(58168),a=(n(96540),n(15680));const l={sidebar_position:1},i="API\u7b80\u4ecb",s={unversionedId:"ApiDoc/synopsis",id:"ApiDoc/synopsis",title:"API\u7b80\u4ecb",description:"\u4e0b\u8f7dPDF\u6587\u6863",source:"@site/docs/ApiDoc/synopsis.md",sourceDirName:"ApiDoc",slug:"/ApiDoc/synopsis",permalink:"/help/docs/ApiDoc/synopsis",draft:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/ApiDoc/synopsis.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1},sidebar:"cn_APi_Afs",next:{title:"Introduction",permalink:"/help/docs/API/aec2/elasticcomputeclusterservice-api"}},g={},c=[{value:"\u4f7f\u7528\u6307\u5357",id:"\u4f7f\u7528\u6307\u5357",level:2},{value:"API\u4f7f\u7528",id:"api\u4f7f\u7528",level:3},{value:"\u7b2c\u4e00\u6b65\uff1a\u521b\u5efaAccessKey",id:"\u7b2c\u4e00\u6b65\u521b\u5efaaccesskey",level:4},{value:"\u7b2c\u4e8c\u6b65\uff1a\u67e5\u770bAPI\u6587\u6863",id:"\u7b2c\u4e8c\u6b65\u67e5\u770bapi\u6587\u6863",level:4},{value:"\u7b2c\u4e09\u6b65\uff1a\u4f9d\u636e\u63a5\u53e3\u6587\u6863\u5b9e\u73b0\u4e1a\u52a1\u903b\u8f91",id:"\u7b2c\u4e09\u6b65\u4f9d\u636e\u63a5\u53e3\u6587\u6863\u5b9e\u73b0\u4e1a\u52a1\u903b\u8f91",level:4},{value:"API\u8c03\u8bd5",id:"api\u8c03\u8bd5",level:3},{value:"\u7b2c\u4e00\u6b65\uff1a\u590d\u5236 Bearer \u4ee4\u724c",id:"\u7b2c\u4e00\u6b65\u590d\u5236-bearer-\u4ee4\u724c",level:4},{value:"\u7b2c\u4e8c\u6b65\uff1a\u4f7f\u7528 Bearer \u4ee4\u724c\u8fdb\u884c API \u8c03\u8bd5",id:"\u7b2c\u4e8c\u6b65\u4f7f\u7528-bearer-\u4ee4\u724c\u8fdb\u884c-api-\u8c03\u8bd5",level:4},{value:"\u8bbf\u95ee\u7aef\u70b9",id:"\u8bbf\u95ee\u7aef\u70b9",level:2},{value:"\u5982\u4f55\u8c03\u7528API",id:"\u5982\u4f55\u8c03\u7528api",level:2},{value:"\u8bf7\u6c42\u5185\u5bb9",id:"\u8bf7\u6c42\u5185\u5bb9",level:3},{value:"\u8bf7\u6c42URI",id:"\u8bf7\u6c42uri",level:4},{value:"\u8bf7\u6c42\u65b9\u6cd5",id:"\u8bf7\u6c42\u65b9\u6cd5",level:4},{value:"\u8bf7\u6c42\u6d88\u606f\u5934",id:"\u8bf7\u6c42\u6d88\u606f\u5934",level:4},{value:"\u8bf7\u6c42\u6d88\u606f\u4f53",id:"\u8bf7\u6c42\u6d88\u606f\u4f53",level:4},{value:"\u8ba4\u8bc1\u9274\u6743",id:"\u8ba4\u8bc1\u9274\u6743",level:3},{value:"\u8bbf\u95ee\u51ed\u8bc1",id:"\u8bbf\u95ee\u51ed\u8bc1",level:4},{value:"\u8bf7\u6c42\u7b7e\u540d",id:"\u8bf7\u6c42\u7b7e\u540d",level:4},{value:"\u8ba1\u7b97\u7b7e\u540d",id:"\u8ba1\u7b97\u7b7e\u540d",level:4},{value:"\u4f8b\u5b50",id:"\u4f8b\u5b50",level:4},{value:"\u8bbf\u95ee\u793a\u4f8b",id:"\u8bbf\u95ee\u793a\u4f8b",level:3}],o={toc:c},p="wrapper";function y(e){let{components:t,...l}=e;return(0,a.yg)(p,(0,r.A)({},o,l,{components:t,mdxType:"MDXLayout"}),(0,a.yg)("h1",{id:"api\u7b80\u4ecb"},"API\u7b80\u4ecb"),(0,a.yg)("div",{className:"md_head_box"},(0,a.yg)("a",{href:"/download/api_synopsis.pdf",target:"_blank",className:"but_download"},"\u4e0b\u8f7dPDF\u6587\u6863")),"# \u6982\u8ff0 OpenAPI\u662fSenseCore\u5bf9\u5916\u63d0\u4f9b\u7edf\u4e00\u89c4\u8303\u4ea7\u54c1API\u670d\u52a1\u7684\u5165\u53e3\uff0c\u4e3a\u673a\u6784\u3001\u670d\u52a1\u5546\u4ee5\u53ca\u5e7f\u5927\u5f00\u53d1\u8005\u63d0\u4f9b\u7edf\u4e00\u6807\u51c6\u3001\u7edf\u4e00\u6d41\u7a0b\u7684API\u8c03\u7528\u670d\u52a1\u3002 OpenAPI\u63d0\u4f9b\u4e86REST\uff08Representational State Transfer\uff09\u98ce\u683cAPI\uff0c\u652f\u6301\u60a8\u901a\u8fc7HTTPS\u8bf7\u6c42\u8c03\u7528\uff0c\u5b83\u4f7f\u7528\u7edf\u4e00\u7684\u63a5\u53e3\u548c\u6807\u51c6\u7684 HTTP \u65b9\u6cd5\u6765\u8fdb\u884c\u8d44\u6e90\u7684\u521b\u5efa\u3001\u8bfb\u53d6\u3001\u66f4\u65b0\u548c\u5220\u9664\u64cd\u4f5c\u3002",(0,a.yg)("h2",{id:"\u4f7f\u7528\u6307\u5357"},"\u4f7f\u7528\u6307\u5357"),(0,a.yg)("h3",{id:"api\u4f7f\u7528"},"API\u4f7f\u7528"),(0,a.yg)("h4",{id:"\u7b2c\u4e00\u6b65\u521b\u5efaaccesskey"},"\u7b2c\u4e00\u6b65\uff1a\u521b\u5efaAccessKey"),(0,a.yg)("ol",null,(0,a.yg)("li",{parentName:"ol"},"\u767b\u5f55\u7528\u6237\u63a7\u5236\u53f0\uff0c\u5728\u5934\u50cf-\u4e0b\u62c9\u83dc\u5355\u4e2d\u70b9\u51fb ",(0,a.yg)("strong",{parentName:"li"},"AccessKey")," \u8bbf\u95ee\u79d8\u94a5\uff0c\u8fdb\u5165\u8d26\u53f7\u4e2d\u5fc3-AccessKey \u8bbf\u95ee\u79d8\u94a5\u9875\u3002\n",(0,a.yg)("img",{src:n(30081).A,width:"1467",height:"787"}),(0,a.yg)("img",{src:n(58176).A,width:"1468",height:"782"})),(0,a.yg)("li",{parentName:"ol"},"\u5728AccessKey \u8bbf\u95ee\u79d8\u94a5\u9875\u4e2d\uff0c\u70b9\u51fb",(0,a.yg)("strong",{parentName:"li"},"\u521b\u5efa\u8bbf\u95ee\u79d8\u94a5"),"\uff0c\u521b\u5efa\u4e00\u5bf9\u5c5e\u4e8e\u5f53\u524d\u8d26\u53f7\u7684\u8bbf\u95ee\u79d8\u94a5\u3002\u79d8\u94a5\u5bf9\u7531 AccessKey ID \u548c AccessKey Secret \u7ec4\u6210\uff0c\u6bcf\u4e2a\u7528\u6237\u6700\u591a\u652f\u6301\u521b\u5efa\u4e24\u5bf9\u5bc6\u94a5\u5bf9\uff0c\u521b\u5efa\u540e\u8bf7\u6ce8\u610f\u5373\u65f6\u4fdd\u5b58 AccessKey Secret \u4fe1\u606f\u3002")),(0,a.yg)("h4",{id:"\u7b2c\u4e8c\u6b65\u67e5\u770bapi\u6587\u6863"},"\u7b2c\u4e8c\u6b65\uff1a\u67e5\u770bAPI\u6587\u6863"),(0,a.yg)("ol",null,(0,a.yg)("li",{parentName:"ol"},"\u5728\u9876\u5bfc\u822a\u4e2d\uff0c\u70b9\u51fb\u6587\u6863\uff0c\u8fdb\u5165\u5e2e\u52a9\u4e2d\u5fc3\u3002"),(0,a.yg)("li",{parentName:"ol"},"\u5728\u6587\u6863\u4e2d\u5fc3\u4e2d\uff0c\u9009\u62e9\u5e76\u5c55\u5f00\u9700\u8981\u67e5\u770b\u7684\u4ea7\u54c1\u670d\u52a1\u540d\u79f0\uff0c\u70b9\u51fb API \u53c2\u8003\u67e5\u770b\u76f8\u5173 API \u8bf4\u660e\u6587\u6863\u3002")),(0,a.yg)("h4",{id:"\u7b2c\u4e09\u6b65\u4f9d\u636e\u63a5\u53e3\u6587\u6863\u5b9e\u73b0\u4e1a\u52a1\u903b\u8f91"},"\u7b2c\u4e09\u6b65\uff1a\u4f9d\u636e\u63a5\u53e3\u6587\u6863\u5b9e\u73b0\u4e1a\u52a1\u903b\u8f91"),(0,a.yg)("p",null,"\u60a8\u4e5f\u53ef\u4ee5\u70b9\u51fb\u63a5\u53e3\u6587\u6863\u4e2d\u7684\u8c03\u8bd5\u63a5\u53e3\u6309\u94ae\uff0c\u8fdb\u5165 API \u4e2d\u5fc3\u8fdb\u884c\u76f8\u5173\u63a5\u53e3\u8c03\u8bd5\u3002"),(0,a.yg)("h3",{id:"api\u8c03\u8bd5"},"API\u8c03\u8bd5"),(0,a.yg)("h4",{id:"\u7b2c\u4e00\u6b65\u590d\u5236-bearer-\u4ee4\u724c"},"\u7b2c\u4e00\u6b65\uff1a\u590d\u5236 Bearer \u4ee4\u724c"),(0,a.yg)("ol",null,(0,a.yg)("li",{parentName:"ol"},"\u5728\u9876\u5bfc\u822a-\u5934\u50cf\u4e0b\u62c9\u83dc\u5355\u4e2d\u70b9\u51fb\u8d26\u53f7\u5b89\u5168\u8bbe\u7f6e\u3002"),(0,a.yg)("li",{parentName:"ol"},"\u70b9\u51fb\u590d\u5236\u6309\u94ae\uff0c\u590d\u5236 Bearer \u4ee4\u724c\u3002")),(0,a.yg)("p",null,(0,a.yg)("img",{src:n(70315).A,width:"3020",height:"1658"})),(0,a.yg)("h4",{id:"\u7b2c\u4e8c\u6b65\u4f7f\u7528-bearer-\u4ee4\u724c\u8fdb\u884c-api-\u8c03\u8bd5"},"\u7b2c\u4e8c\u6b65\uff1a\u4f7f\u7528 Bearer \u4ee4\u724c\u8fdb\u884c API \u8c03\u8bd5"),(0,a.yg)("ol",null,(0,a.yg)("li",{parentName:"ol"},"\u5c06\u590d\u5236\u597d\u7684 Bearer\u4ee4\u724c\u7c98\u8d34\u5230 API \u8c03\u8bd5\u9875\u4e2d\u7684 Beaer Token \u586b\u5199\u6846\u4e2d\u3002"),(0,a.yg)("li",{parentName:"ol"},"\u5f00\u59cb\u8fdb\u884c API \u8c03\u8bd5\u3002")),(0,a.yg)("h2",{id:"\u8bbf\u95ee\u7aef\u70b9"},"\u8bbf\u95ee\u7aef\u70b9"),(0,a.yg)("p",null,"\u8be6\u60c5\u8bf7\u67e5\u770b\u5404\u4e2a\u4ea7\u54c1\u7684OpenAPI\u8bf4\u660e\u6587\u6863"),(0,a.yg)("h2",{id:"\u5982\u4f55\u8c03\u7528api"},"\u5982\u4f55\u8c03\u7528API"),(0,a.yg)("h3",{id:"\u8bf7\u6c42\u5185\u5bb9"},"\u8bf7\u6c42\u5185\u5bb9"),(0,a.yg)("h4",{id:"\u8bf7\u6c42uri"},"\u8bf7\u6c42URI"),(0,a.yg)("p",null,"\u8bf7\u6c42URI\u7531\u5982\u4e0b\u90e8\u5206\u7ec4\u6210\u3002"),(0,a.yg)("p",null,(0,a.yg)("strong",{parentName:"p"},"{scheme} :// {Endpoint} / {resource-path} ? {query-string}")),(0,a.yg)("p",null,"\u5c3d\u7ba1\u8bf7\u6c42URI\u5305\u542b\u5728\u8bf7\u6c42\u6d88\u606f\u5934\u4e2d\uff0c\u4f46\u5927\u591a\u6570\u8bed\u8a00\u6216\u6846\u67b6\u90fd\u8981\u6c42\u60a8\u4ece\u8bf7\u6c42\u6d88\u606f\u4e2d\u5355\u72ec\u4f20\u9012\u5b83\uff0c\u6240\u4ee5\u5728\u6b64\u5355\u72ec\u5f3a\u8c03\u3002"),(0,a.yg)("ul",null,(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"scheme"),"\uff1a\u8868\u793a\u7528\u4e8e\u4f20\u8f93\u8bf7\u6c42\u7684\u534f\u8bae\uff0c\u5f53\u524d\u6240\u6709API\u5747\u91c7\u7528",(0,a.yg)("strong",{parentName:"li"},"HTTPS"),"\u534f\u8bae\u3002"),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Endpoint"),"\uff1a\u6307\u5b9a\u627f\u8f7dREST\u670d\u52a1\u7aef\u70b9\u7684\u670d\u52a1\u5668\u57df\u540d\u6216IP\uff0c\u4e0d\u540c\u670d\u52a1\u4e0d\u540c\u533a\u57df\u7684Endpoint\u4e0d\u540c"),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"resource-path"),"\uff1a\u8d44\u6e90\u8def\u5f84\uff0c\u4e5f\u5373API\u8bbf\u95ee\u8def\u5f84\u3002"),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"query-string"),"\uff1a\u67e5\u8be2\u53c2\u6570\uff0c\u662f\u53ef\u9009\u90e8\u5206\uff0c\u5e76\u4e0d\u662f\u6bcf\u4e2aAPI\u90fd\u6709\u67e5\u8be2\u53c2\u6570\u3002\u67e5\u8be2\u53c2\u6570\u524d\u9762\u9700\u8981\u5e26\u4e00\u4e2a\u201c\uff1f\u201d\uff0c\u5f62\u5f0f\u4e3a\u201c\u53c2\u6570\u540d=\u53c2\u6570\u53d6\u503c\u201d\uff0c\u4f8b\u5982\u201climit=10\u201d\uff0c\u8868\u793a\u67e5\u8be2\u4e0d\u8d85\u8fc710\u6761\u6570\u636e\u3002")),(0,a.yg)("h4",{id:"\u8bf7\u6c42\u65b9\u6cd5"},"\u8bf7\u6c42\u65b9\u6cd5"),(0,a.yg)("p",null,"HTTP\u8bf7\u6c42\u65b9\u6cd5\uff08\u4e5f\u79f0\u4e3a\u64cd\u4f5c\u6216\u52a8\u8bcd\uff09\uff0c\u5b83\u544a\u8bc9\u670d\u52a1\u4f60\u6b63\u5728\u8bf7\u6c42\u4ec0\u4e48\u7c7b\u578b\u7684\u64cd\u4f5c\u3002"),(0,a.yg)("ul",null,(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"GET"),"\uff1a\u8bf7\u6c42\u670d\u52a1\u5668\u8fd4\u56de\u6307\u5b9a\u8d44\u6e90\u3002"),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"PUT"),"\uff1a\u8bf7\u6c42\u670d\u52a1\u5668\u66f4\u65b0\u6307\u5b9a\u8d44\u6e90\u3002"),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"POST"),"\uff1a\u8bf7\u6c42\u670d\u52a1\u5668\u65b0\u589e\u8d44\u6e90\u6216\u6267\u884c\u7279\u6b8a\u64cd\u4f5c\u3002"),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"DELETE"),"\uff1a\u8bf7\u6c42\u670d\u52a1\u5668\u5220\u9664\u6307\u5b9a\u8d44\u6e90\uff0c\u5982\u5220\u9664\u5bf9\u8c61\u7b49\u3002"),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"HEAD"),"\uff1a\u8bf7\u6c42\u670d\u52a1\u5668\u8d44\u6e90\u5934\u90e8\u3002"),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"PATCH"),"\uff1a\u8bf7\u6c42\u670d\u52a1\u5668\u66f4\u65b0\u8d44\u6e90\u7684\u90e8\u5206\u5185\u5bb9\u3002\u5f53\u8d44\u6e90\u4e0d\u5b58\u5728\u7684\u65f6\u5019\uff0cPATCH\u53ef\u80fd\u4f1a\u53bb\u521b\u5efa\u4e00\u4e2a\u65b0\u7684\u8d44\u6e90\u3002")),(0,a.yg)("h4",{id:"\u8bf7\u6c42\u6d88\u606f\u5934"},"\u8bf7\u6c42\u6d88\u606f\u5934"),(0,a.yg)("p",null,"\u9644\u52a0\u8bf7\u6c42\u5934\u5b57\u6bb5\uff0c\u5982\u6307\u5b9a\u7684URI\u548cHTTP\u65b9\u6cd5\u6240\u8981\u6c42\u7684\u5b57\u6bb5\u3002\u4f8b\u5982\u5b9a\u4e49\u6d88\u606f\u4f53\u7c7b\u578b\u7684\u8bf7\u6c42\u5934\u201cContent-Type\u201d\uff0c\u8bf7\u6c42\u9274\u6743\u4fe1\u606f\u7b49\u3002"),(0,a.yg)("p",null,"\u5982\u4e0b\u516c\u5171\u6d88\u606f\u5934\u9700\u8981\u6dfb\u52a0\u5230\u8bf7\u6c42\u4e2d\u3002"),(0,a.yg)("ul",null,(0,a.yg)("li",{parentName:"ul"},"X-Date: \u8be5\u8bf7\u6c42\u751f\u6210\u65f6\u7684\u65f6\u95f4\u548c\u65e5\u671f\u3002 "),(0,a.yg)("li",{parentName:"ul"},"Authorization\uff1a\u8be5\u8bf7\u6c42\u7684\u8ba4\u8bc1\u4fe1\u606f\n\u8bf7\u6c42\u6d88\u606f\u4f53")),(0,a.yg)("h4",{id:"\u8bf7\u6c42\u6d88\u606f\u4f53"},"\u8bf7\u6c42\u6d88\u606f\u4f53"),(0,a.yg)("p",null,"\u8bf7\u6c42\u6d88\u606f\u4f53\u901a\u5e38\u4ee5\u7ed3\u6784\u5316\u683c\u5f0f\u53d1\u51fa\uff0c\u4e0e\u8bf7\u6c42\u6d88\u606f\u5934\u4e2dContent-type\u5bf9\u5e94\uff0c\u4f20\u9012\u9664\u8bf7\u6c42\u6d88\u606f\u5934\u4e4b\u5916\u7684\u5185\u5bb9\u3002\u82e5\u8bf7\u6c42\u6d88\u606f\u4f53\u4e2d\u53c2\u6570\u652f\u6301\u4e2d\u6587\uff0c\u5219\u4e2d\u6587\u5b57\u7b26\u5fc5\u987b\u4e3aUTF-8\u7f16\u7801\u3002"),(0,a.yg)("p",null,"\u6bcf\u4e2a\u63a5\u53e3\u7684\u8bf7\u6c42\u6d88\u606f\u4f53\u5185\u5bb9\u4e0d\u540c\uff0c\u4e5f\u5e76\u4e0d\u662f\u6bcf\u4e2a\u63a5\u53e3\u90fd\u9700\u8981\u6709\u8bf7\u6c42\u6d88\u606f\u4f53\uff08\u6216\u8005\u8bf4\u6d88\u606f\u4f53\u4e3a\u7a7a\uff09\uff0cGET\u3001DELETE\u64cd\u4f5c\u7c7b\u578b\u7684\u63a5\u53e3\u5c31\u4e0d\u9700\u8981\u6d88\u606f\u4f53\uff0c\u6d88\u606f\u4f53\u5177\u4f53\u5185\u5bb9\u9700\u8981\u6839\u636e\u5177\u4f53\u63a5\u53e3\u800c\u5b9a\u3002"),(0,a.yg)("h3",{id:"\u8ba4\u8bc1\u9274\u6743"},"\u8ba4\u8bc1\u9274\u6743"),(0,a.yg)("h4",{id:"\u8bbf\u95ee\u51ed\u8bc1"},"\u8bbf\u95ee\u51ed\u8bc1"),(0,a.yg)("p",null,"Access Key\uff08\u8bbf\u95ee\u5bc6\u94a5\uff09\u662f\u4e00\u79cd\u7528\u4e8e\u8eab\u4efd\u9a8c\u8bc1\u548c\u6388\u6743\u7684\u51ed\u636e\uff0c\u7528\u4e8e\u8bbf\u95ee\u548c\u4f7f\u7528\u5404\u79cd\u670d\u52a1\u548cAPI\u3002Access Key \u901a\u5e38\u7531\u7528\u6237\u5728\u7528\u6237\u63a7\u5236\u53f0-\u5b89\u5168\u4e2d\u5fc3\u751f\u6210\u548c\u7ba1\u7406\u3002"),(0,a.yg)("p",null,"Access Key \u7531\u4e24\u90e8\u5206\u7ec4\u6210\uff1aAccess Key ID\uff08\u8bbf\u95ee\u5bc6\u94a5\u6807\u8bc6\u7b26\uff09\u548c Secret Access Key\uff08\u8bbf\u95ee\u5bc6\u94a5\u5bc6\u94a5\uff09\u3002Access Key ID \u662f\u7528\u4e8e\u6807\u8bc6\u8bbf\u95ee\u5bc6\u94a5\u7684\u552f\u4e00\u6807\u8bc6\u7b26\uff0c\u800c Secret Access Key \u5219\u662f\u7528\u4e8e\u5bf9\u8bf7\u6c42\u8fdb\u884c\u7b7e\u540d\u548c\u8eab\u4efd\u9a8c\u8bc1\u7684\u673a\u5bc6\u5bc6\u94a5\u3002"),(0,a.yg)("p",null,"\u4f7f\u7528 Access Key \u8fdb\u884c\u8eab\u4efd\u9a8c\u8bc1\u53ef\u4ee5\u63d0\u4f9b\u4e00\u5b9a\u7684\u5b89\u5168\u6027\uff0c\u56e0\u4e3a\u53ea\u6709\u6301\u6709\u6b63\u786e\u7684 Access Key \u624d\u80fd\u901a\u8fc7\u8eab\u4efd\u9a8c\u8bc1\u5e76\u83b7\u5f97\u8bbf\u95ee\u6743\u9650\u3002Access Key \u901a\u5e38\u9700\u8981\u59a5\u5584\u4fdd\u7ba1\uff0c\u907f\u514d\u6cc4\u9732\u7ed9\u672a\u7ecf\u6388\u6743\u7684\u4eba\u5458\u6216\u5e94\u7528\u7a0b\u5e8f\u3002"),(0,a.yg)("p",null,"\u5728\u4f7f\u7528\u67d0\u4e9b\u670d\u52a1\u6216API\u65f6\uff0c\u9700\u8981\u5728\u8bf7\u6c42\u4e2d\u5305\u542b Access Key \u76f8\u5173\u7684\u4fe1\u606f\uff0c\u4ee5\u8bc1\u660e\u8eab\u4efd\u5e76\u83b7\u5f97\u6388\u6743\u3002\u5177\u4f53\u7684\u4f7f\u7528\u65b9\u6cd5\u548c\u8981\u6c42\u53d6\u51b3\u4e8e\u6240\u4f7f\u7528\u7684\u670d\u52a1\u6216API\u7684\u63d0\u4f9b\u5546\u3002\u901a\u5e38\uff0cAccess Key \u76f8\u5173\u7684\u4fe1\u606f\u9700\u8981\u4f5c\u4e3a\u8bf7\u6c42\u7684\u4e00\u90e8\u5206\uff0c\u53ef\u4ee5\u901a\u8fc7\u8bf7\u6c42\u5934\u3001\u8bf7\u6c42\u53c2\u6570\u6216\u8bf7\u6c42\u4f53\u7684\u5f62\u5f0f\u8fdb\u884c\u4f20\u9012\u3002"),(0,a.yg)("h4",{id:"\u8bf7\u6c42\u7b7e\u540d"},"\u8bf7\u6c42\u7b7e\u540d"),(0,a.yg)("p",null,"\u5e73\u53f0\u63d0\u4f9b\u4e86\u5b89\u5168\u7684",(0,a.yg)("strong",{parentName:"p"},"\u7b7e\u540d\u6821\u9a8c"),"\u65b9\u5f0f\uff0cAPI\u8bbf\u95ee\u4e2d\u9700\u8981\u751f\u6210Http Authorization Header, \u53ea\u6709\u901a\u8fc7\u7b7e\u540d\u6821\u9a8c\u7684\u8bf7\u6c42\u624d\u80fd\u5230\u8fbe\u4e1a\u52a1\u540e\u7aef\u3002"),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre"},'\n Authorization: hmac accesskey="{accesskey}", algorithm="{algorithm}", headers="{headers}", signature="{signature}"\n\n')),(0,a.yg)("table",null,(0,a.yg)("thead",{parentName:"table"},(0,a.yg)("tr",{parentName:"thead"},(0,a.yg)("th",{parentName:"tr",align:null},"\u53c2\u6570\u540d\u79f0"),(0,a.yg)("th",{parentName:"tr",align:null},"\u7c7b\u578b"),(0,a.yg)("th",{parentName:"tr",align:null},"\u8bf4\u660e"))),(0,a.yg)("tbody",{parentName:"table"},(0,a.yg)("tr",{parentName:"tbody"},(0,a.yg)("td",{parentName:"tr",align:null},"accesskey"),(0,a.yg)("td",{parentName:"tr",align:null},"string"),(0,a.yg)("td",{parentName:"tr",align:null},"\u7528\u6237\u7684access key id")),(0,a.yg)("tr",{parentName:"tbody"},(0,a.yg)("td",{parentName:"tr",align:null},"algorithm"),(0,a.yg)("td",{parentName:"tr",align:null},"string"),(0,a.yg)("td",{parentName:"tr",align:null},"hmac-sha256")),(0,a.yg)("tr",{parentName:"tbody"},(0,a.yg)("td",{parentName:"tr",align:null},"headers"),(0,a.yg)("td",{parentName:"tr",align:null},"string"),(0,a.yg)("td",{parentName:"tr",align:null},"\u53c2\u4e0e\u7b7e\u540d\u8ba1\u7b97\u7684header, \u5f53\u524d\u4e3ax-date \u548crequest-line")),(0,a.yg)("tr",{parentName:"tbody"},(0,a.yg)("td",{parentName:"tr",align:null},"signature"),(0,a.yg)("td",{parentName:"tr",align:null},"string"),(0,a.yg)("td",{parentName:"tr",align:null},"\u8bf7\u6c42\u7b7e\u540d")))),(0,a.yg)("h4",{id:"\u8ba1\u7b97\u7b7e\u540d"},"\u8ba1\u7b97\u7b7e\u540d"),(0,a.yg)("p",null,"\u5bf9HTTP\u8bf7\u6c42\u8fdb\u884c\u89c4\u8303\u5e76\u53d6\u5f97\u8bf7\u6c42\u7684\u54c8\u5e0c\u503c\u540e\uff0c\u5c06\u5176\u4e0e\u7b7e\u540d\u7b97\u6cd5\u3001\u7b7e\u540d\u65f6\u95f4\u4e00\u8d77\u7ec4\u6210\u5f85\u7b7e\u540d\u5b57\u7b26\u4e32\u3002"),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre"},'\nStringToSign =\n "x-data: {X-Data}" + \\n +\n {RequestLine}\n\n')),(0,a.yg)("p",null,"\u4f2a\u4ee3\u7801\u4e2d\u53c2\u6570\u8bf4\u660e\u5982\u4e0b\u3002"),(0,a.yg)("ul",null,(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"X-Date"),"\uff1a\u8bf7\u6c42\u65f6\u95f4\u6233\u3002"),(0,a.yg)("li",{parentName:"ul"},"\u683c\u5f0f\u53c2\u8003",(0,a.yg)("a",{parentName:"li",href:"https://datatracker.ietf.org/doc/html/rfc2616#section-3.3"},"https://datatracker.ietf.org/doc/html/rfc2616#section-3.3")," "),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"RequestLine"),"\uff1a",(0,a.yg)("a",{parentName:"li",href:"https://datatracker.ietf.org/doc/html/rfc2616#section-5.1"},"https://datatracker.ietf.org/doc/html/rfc2616#section-5.1 "))),(0,a.yg)("p",null,"\u5c06SK\uff08Secret Access Key\uff09\u548c\u521b\u5efa\u7684\u5f85\u7b7e\u5b57\u7b26\u4e32\u4f5c\u4e3a\u52a0\u5bc6\u54c8\u5e0c\u51fd\u6570\u7684\u8f93\u5165\uff0c\u8ba1\u7b97\u7b7e\u540d\uff0c\u5c06\u4e8c\u8fdb\u5236\u503c\u8f6c\u6362\u4e3abase64\u8868\u793a\u5f62\u5f0f\u3002\u4f2a\u4ee3\u7801\u5982\u4e0b\uff1a"),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre"},"\nsignature = Base64Encode(HMAC(Secret Access Key, StringToSign))\n\n")),(0,a.yg)("table",null,(0,a.yg)("tr",null,(0,a.yg)("td",null,"Secret Access Key"),(0,a.yg)("td",null,"\u7b7e\u540d\u5bc6\u94a5")),(0,a.yg)("tr",null,(0,a.yg)("td",null,"string to sign "),(0,a.yg)("td",null,"\u521b\u5efa\u7684\u5f85\u7b7e\u5b57\u7b26\u4e32"))),(0,a.yg)("h4",{id:"\u4f8b\u5b50"},"\u4f8b\u5b50"),(0,a.yg)("p",null,"AccessKey ID: 9eb0a32f-09c6-48da-8feb-34806dd60bdc"),(0,a.yg)("p",null,"AccessKey Secret: secret"),(0,a.yg)("p",null,"X-Date: Thu, 22 Jun 2017 17:15:21 GMT"),(0,a.yg)("p",null,"request-line: GET /requests HTTP/1.1"),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre"},'StringToSign = "x-data: {X-Data}" + \\n +{RequestLine}\n = "x-date: Thu, 22 Jun 2017 17:15:21 GMT\\nGET /requests HTTP/1.1"\nsignature = base64(hmac_sha256("secret", StringToSign)) \n = "IXlgb2baHcvPrV7a/C+hKS+E5oHIQXXyz4k4maWws50="\n\n')),(0,a.yg)("h3",{id:"\u8bbf\u95ee\u793a\u4f8b"},"\u8bbf\u95ee\u793a\u4f8b"),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre"},'\npackage main\n\nimport (\n "crypto/hmac"\n "crypto/sha256"\n "encoding/base64"\n "fmt"\n "net/http"\n "strings"\n "time"\n)\n\nfunc hmac_sha256(secret string, message string) string {\n key := []byte(secret)\n h := hmac.New(sha256.New, key)\n h.Write([]byte(message))\n return base64.StdEncoding.EncodeToString(h.Sum(nil))\n}\n\nfunc main() {\n \n // information\n strAKID := "demo access key id" //\u66ff\u6362\u4e3a\u4f60\u7684Access key\n strAKSecret := "demo access key secret" //\u66ff\u6362\u4e3a\u4f60\u7684Access Secret\n strDateNow := time.Now().UTC().Format(http.TimeFormat)\n strAlgorithm := "hmac-sha256"\n strHeaders := "x-date request-line"\n\n // compute request signature\n strXDate := fmt.Sprintf("x-date: %s", strDateNow)\n strRequestLine := "GET /iam/idp/v1/users:getProfile HTTP/1.1"\n\n strSignContent := strings.Join([]string{strXDate, strRequestLine}, "\\n")\n strSignature := hmac_sha256(strAKSecret, strSignContent)\n\n // generate Header Authorization\n strAuthorization := fmt.Sprintf(`hmac accesskey="%s", algorithm="%s", headers="%s", signature="%s"`, strAKID, strAlgorithm, strHeaders, strSignature)\n\n fmt.Println(strAuthorization)\n\n // send request\n strURL := "https://iam.sensecoreapi.dev/iam/idp/v1/users:getProfile"\n req, _ := http.NewRequest(http.MethodGet, strURL, nil)\n req.Header.Set("X-Date", strDateNow)\n req.Header.Set("Authorization", strAuthorization)\n\n client := http.Client{}\n\n _, err := client.Do(req)\n fmt.Println(err)\n \n}\n\n')))}y.isMDXComponent=!0},58176:(e,t,n)=>{n.d(t,{A:()=>r});const r=n.p+"assets/images/add_aksk-dcaa8dfe0a2753211e5ece3af547569b.png"},70315:(e,t,n)=>{n.d(t,{A:()=>r});const r=n.p+"assets/images/copy_token-5a300b7806e05c638d980acd98bc3051.png"},30081:(e,t,n)=>{n.d(t,{A:()=>r});const r=n.p+"assets/images/create_aksk-3727aa2691dab5ed300bbe8c9268b47b.png"}}]);