yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity

APIG API 20241218 version

Browse Source 
Reviewed-by: Ziuzko, Stanislav <stanislav.ziuzko@t-systems.com>
Co-authored-by: chenjunjie <chenjunjie@huawei.com>
Co-committed-by: chenjunjie <chenjunjie@huawei.com>
This commit is contained in:
Chen, Junjie
2025-03-27 13:05:54 +00:00
committed by zuul
parent c5d2d3b6dc
commit c18df8d8fe
22 changed files with 2388 additions and 2431 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/apig/api-ref/ALL_META.TXT.json
View File

@ -289,7 +289,7 @@
"node_id":"createenvironmentv2.xml", "node_id":"createenvironmentv2.xml",
"product_code":"apig", "product_code":"apig",
"code":"16", "code":"16",
"des":"API poviders can publish an API in different environments, such as the development, test, and production environmentsAPI information, such as the version, request address", "des":"API providers can publish an API in different environments, such as the development, test, and production environmentsAPI information, such as the version, request addres",
"doc_type":"api", "doc_type":"api",
"kw":"Creating an Environment,Environment Management,API Reference", "kw":"Creating an Environment,Environment Management,API Reference",
"search_title":"", "search_title":"",
@ -3267,7 +3267,7 @@
"node_id":"createpostpayresizeorder.xml", "node_id":"createpostpayresizeorder.xml",
"product_code":"apig", "product_code":"apig",
"code":"167", "code":"167",
"des":"This API is used to creat a specification change order of a pay-per-use gateway.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/postpaid", "des":"This API is used to create a specification change order of a pay-per-use gateway.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/postpai",
"doc_type":"api", "doc_type":"api",
"kw":"Modifying the Specifications of a Pay-Per-Use Gateway,Gateway Management,API Reference", "kw":"Modifying the Specifications of a Pay-Per-Use Gateway,Gateway Management,API Reference",
"search_title":"", "search_title":"",
@ -4393,7 +4393,7 @@
"node_id":"createappquota.xml", "node_id":"createappquota.xml",
"product_code":"apig", "product_code":"apig",
"code":"224", "code":"224",
"des":"Creating a Credential QuotaFor details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/app-quotasStatus code: 201Status code: 400Status code: 401Sta", "des":"This API is used to create a credential quota.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/app-quotasStatus code: 201Status code: 400",
"doc_type":"api", "doc_type":"api",
"kw":"Creating a Credential Quota,Credential Quota Management,API Reference", "kw":"Creating a Credential Quota,Credential Quota Management,API Reference",
"search_title":"", "search_title":"",

6
docs/apig/api-ref/CLASS.TXT.json
View File

@ -135,7 +135,7 @@
"code":"15" "code":"15"
}, },
{ {
"desc":"API poviders can publish an API in different environments, such as the development, test, and production environmentsAPI information, such as the version, request address", "desc":"API providers can publish an API in different environments, such as the development, test, and production environmentsAPI information, such as the version, request addres",
"product_code":"apig", "product_code":"apig",
"title":"Creating an Environment", "title":"Creating an Environment",
"uri":"CreateEnvironmentV2.html", "uri":"CreateEnvironmentV2.html",
@ -1494,7 +1494,7 @@
"code":"166" "code":"166"
}, },
{ {
"desc":"This API is used to creat a specification change order of a pay-per-use gateway.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/postpaid", "desc":"This API is used to create a specification change order of a pay-per-use gateway.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/postpai",
"product_code":"apig", "product_code":"apig",
"title":"Modifying the Specifications of a Pay-Per-Use Gateway", "title":"Modifying the Specifications of a Pay-Per-Use Gateway",
"uri":"CreatePostPayResizeOrder.html", "uri":"CreatePostPayResizeOrder.html",
@ -2007,7 +2007,7 @@
"code":"223" "code":"223"
}, },
{ {
"desc":"Creating a Credential QuotaFor details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/app-quotasStatus code: 201Status code: 400Status code: 401Sta", "desc":"This API is used to create a credential quota.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/app-quotasStatus code: 201Status code: 400",
"product_code":"apig", "product_code":"apig",
"title":"Creating a Credential Quota", "title":"Creating a Credential Quota",
"uri":"CreateAppQuota.html", "uri":"CreateAppQuota.html",

2
docs/apig/api-ref/CreateAppQuota.html
View File

@ -1,7 +1,7 @@
<a name="CreateAppQuota"></a><a name="CreateAppQuota"></a> <a name="CreateAppQuota"></a><a name="CreateAppQuota"></a>
<h1 class="topictitle1">Creating a Credential Quota</h1> <h1 class="topictitle1">Creating a Credential Quota</h1>
<div id="body55521934797"><div class="section" id="CreateAppQuota__section45538349918"><h4 class="sectiontitle">Function</h4><p id="CreateAppQuota__p2055318342914">Creating a Credential Quota</p> <div id="body55521934797"><div class="section" id="CreateAppQuota__section45538349918"><h4 class="sectiontitle">Function</h4><p id="CreateAppQuota__p15685145119193">This API is used to create a credential quota.</p>
</div> </div>
<div class="section" id="CreateAppQuota__atuogenerate_1"><h4 class="sectiontitle">Calling Method</h4><p id="CreateAppQuota__p4553143416916">For details, see <a href="apig-api-180713003.html">Calling APIs</a>.</p> <div class="section" id="CreateAppQuota__atuogenerate_1"><h4 class="sectiontitle">Calling Method</h4><p id="CreateAppQuota__p4553143416916">For details, see <a href="apig-api-180713003.html">Calling APIs</a>.</p>
</div> </div>

2
docs/apig/api-ref/CreateEnvironmentV2.html
View File

@ -1,7 +1,7 @@
<a name="CreateEnvironmentV2"></a><a name="CreateEnvironmentV2"></a> <a name="CreateEnvironmentV2"></a><a name="CreateEnvironmentV2"></a>
<h1 class="topictitle1">Creating an Environment</h1> <h1 class="topictitle1">Creating an Environment</h1>
<div id="body1533318115484"><div class="section" id="CreateEnvironmentV2__section933317184811"><h4 class="sectiontitle">Function</h4><p id="CreateEnvironmentV2__p83331118482">API poviders can publish an API in different environments, such as the development, test, and production environments</p> <div id="body1533318115484"><div class="section" id="CreateEnvironmentV2__section933317184811"><h4 class="sectiontitle">Function</h4><p id="CreateEnvironmentV2__p83331118482">API providers can publish an API in different environments, such as the development, test, and production environments</p>
<p id="CreateEnvironmentV2__p113331219489">API information, such as the version, request address, and even request message, varies depending on the environment in which an API is published. For example, v1.0 of an API is published in the production environment, v1.1 in the test environment, and v1.2 in the development environment.</p> <p id="CreateEnvironmentV2__p113331219489">API information, such as the version, request address, and even request message, varies depending on the environment in which an API is published. For example, v1.0 of an API is published in the production environment, v1.1 in the test environment, and v1.2 in the development environment.</p>
<p id="CreateEnvironmentV2__p633319119481">APIG provides environment management, enabling you to access APIG in different scenarios at minimal costs.</p> <p id="CreateEnvironmentV2__p633319119481">APIG provides environment management, enabling you to access APIG in different scenarios at minimal costs.</p>
</div> </div>

2
docs/apig/api-ref/CreatePostPayResizeOrder.html
View File

@ -1,7 +1,7 @@
<a name="CreatePostPayResizeOrder"></a><a name="CreatePostPayResizeOrder"></a> <a name="CreatePostPayResizeOrder"></a><a name="CreatePostPayResizeOrder"></a>
<h1 class="topictitle1">Modifying the Specifications of a Pay-Per-Use Gateway</h1> <h1 class="topictitle1">Modifying the Specifications of a Pay-Per-Use Gateway</h1>
<div id="body32001227"><div class="section" id="CreatePostPayResizeOrder__section557975281518"><h4 class="sectiontitle">Function</h4><p id="CreatePostPayResizeOrder__p7579185210159">This API is used to creat a specification change order of a pay-per-use gateway.</p> <div id="body32001227"><div class="section" id="CreatePostPayResizeOrder__section557975281518"><h4 class="sectiontitle">Function</h4><p id="CreatePostPayResizeOrder__p7579185210159">This API is used to create a specification change order of a pay-per-use gateway.</p>
</div> </div>
<div class="section" id="CreatePostPayResizeOrder__en-us_topic_0000001929686677_atuogenerate_1"><h4 class="sectiontitle">Calling Method</h4><p id="CreatePostPayResizeOrder__p1758095214157">For details, see <a href="apig-api-180713003.html">Calling APIs</a>.</p> <div class="section" id="CreatePostPayResizeOrder__en-us_topic_0000001929686677_atuogenerate_1"><h4 class="sectiontitle">Calling Method</h4><p id="CreatePostPayResizeOrder__p1758095214157">For details, see <a href="apig-api-180713003.html">Calling APIs</a>.</p>
</div> </div>

2956
docs/apig/api-ref/ErrorCode.html
View File

File diff suppressed because it is too large Load Diff

2
docs/apig/api-ref/ListInstanceTags.html
View File

@ -231,7 +231,7 @@
"resource_name" : "apig_instance", "resource_name" : "apig_instance",
"tags" : [ { "tags" : [ {
"key" : "test-key", "key" : "test-key",
"value" : "test-vaue" "value" : "test-value"
} ] } ]
}</pre> }</pre>
<p id="ListInstanceTags__p13940191714153"><strong id="ListInstanceTags__b194091791515">Status code: 401</strong></p> <p id="ListInstanceTags__p13940191714153"><strong id="ListInstanceTags__b194091791515">Status code: 401</strong></p>

1752
docs/apig/api-ref/api-grant-policy.html
View File

File diff suppressed because it is too large Load Diff

2
docs/apig/api-ref/apig-api-180713009.html
View File

@ -2,7 +2,7 @@
<h1 class="topictitle1">Obtaining a Project ID</h1> <h1 class="topictitle1">Obtaining a Project ID</h1>
<div id="body8662426"><div class="section" id="apig-api-180713009__en-us_topic_0172449255_section414113577116"><h4 class="sectiontitle">Calling an API</h4><p id="apig-api-180713009__en-us_topic_0172449255_p184083580537">You can also obtain a project ID by calling the IAM API used to query project information.</p> <div id="body8662426"><div class="section" id="apig-api-180713009__en-us_topic_0172449255_section414113577116"><h4 class="sectiontitle">Calling an API</h4><p id="apig-api-180713009__en-us_topic_0172449255_p184083580537">You can also obtain a project ID by calling the IAM API used to query project information.</p>
<p id="apig-api-180713009__en-us_topic_0172449255_p82371314564">The API used to obtain a project ID is "GET https://<em id="apig-api-180713009__en-us_topic_0172449255_i756894312434">{Endpoint}</em>/v3/projects/". <em id="apig-api-180713009__en-us_topic_0172449255_i1555814694311">{Endpoint}</em> is the IAM endpoint and can be obtained from technical support. For details on API calling authentication, see <a href="apig-api-190529268.html#apig-api-190529268">Authentication</a>.</p> <p id="apig-api-180713009__en-us_topic_0172449255_p82371314564">The API used to obtain a project ID is "GET https://<em id="apig-api-180713009__i068742675213">{Endpoint}</em>/v3/projects/". <em id="apig-api-180713009__i14687162613527">{Endpoint}</em> is the IAM endpoint and can be obtained from technical support. For details on API calling authentication, see <a href="apig-api-190529268.html">Authentication</a>.</p>
<p id="apig-api-180713009__en-us_topic_0172449255_p1461198134114">The following is an example response. The value of <strong id="apig-api-180713009__en-us_topic_0172449255_b3237123414241">id</strong> in the <strong id="apig-api-180713009__en-us_topic_0172449255_b7237143482412">projects</strong> field is the project ID.</p> <p id="apig-api-180713009__en-us_topic_0172449255_p1461198134114">The following is an example response. The value of <strong id="apig-api-180713009__en-us_topic_0172449255_b3237123414241">id</strong> in the <strong id="apig-api-180713009__en-us_topic_0172449255_b7237143482412">projects</strong> field is the project ID.</p>
<pre class="screen" id="apig-api-180713009__en-us_topic_0172449255_screen676419149446">{ <pre class="screen" id="apig-api-180713009__en-us_topic_0172449255_screen676419149446">{
"projects": [ "projects": [

5
docs/apig/api-ref/apig-api-180713011.html
View File

@ -5,7 +5,7 @@
<div class="section" id="apig-api-180713011__en-us_topic_0000001942519306_section1849899574"><h4 class="sectiontitle">Request URI</h4><p id="apig-api-180713011__en-us_topic_0000001942519306_p729531715312">A request URI is in the following format:</p> <div class="section" id="apig-api-180713011__en-us_topic_0000001942519306_section1849899574"><h4 class="sectiontitle">Request URI</h4><p id="apig-api-180713011__en-us_topic_0000001942519306_p729531715312">A request URI is in the following format:</p>
<p id="apig-api-180713011__en-us_topic_0000001942519306_p11610193811547"><strong id="apig-api-180713011__en-us_topic_0000001942519306_b3129104565416">{URI-scheme} :// {<strong id="apig-api-180713011__en-us_topic_0000001942519306_b10231116812">Endpoint</strong>} / {resource-path} ? {query-string}</strong></p> <p id="apig-api-180713011__en-us_topic_0000001942519306_p11610193811547"><strong id="apig-api-180713011__en-us_topic_0000001942519306_b3129104565416">{URI-scheme} :// {<strong id="apig-api-180713011__en-us_topic_0000001942519306_b10231116812">Endpoint</strong>} / {resource-path} ? {query-string}</strong></p>
<p id="apig-api-180713011__en-us_topic_0000001942519306_p19153141415558">Although a request URI is included in the request header, most programming languages or frameworks require the request URI to be transmitted separately.</p> <p id="apig-api-180713011__en-us_topic_0000001942519306_p19153141415558">Although a request URI is included in the request header, most programming languages or frameworks require the request URI to be transmitted separately.</p>
<ul id="apig-api-180713011__en-us_topic_0000001942519306_ul63581757356"><li id="apig-api-180713011__en-us_topic_0000001942519306_li183581756359"><strong id="apig-api-180713011__en-us_topic_0000001942519306_b83920310421">URI-scheme</strong>: Protocol used to transmit requests. All APIs use <strong id="apig-api-180713011__en-us_topic_0000001942519306_b539313114215">HTTPS</strong>.</li><li id="apig-api-180713011__en-us_topic_0000001942519306_li16358958354"><strong id="apig-api-180713011__en-us_topic_0000001942519306_b13517165134215">Endpoint</strong>: Domain name or IP address of the server bearing the REST service. It can be obtained from <a href="apig-api-190529263.html#apig-api-190529263__en-us_topic_0000001969180093_section932113578479">Endpoints</a>. .</li><li id="apig-api-180713011__en-us_topic_0000001942519306_li53597512351"><strong id="apig-api-180713011__en-us_topic_0000001942519306_b31682350472">resource-path</strong>: Access path of an API for performing a specified operation. Obtain the path from the URI of an API. For example, the <strong id="apig-api-180713011__en-us_topic_0000001942519306_b1029107104914">resource-path</strong> of the API used to create an API group is <strong id="apig-api-180713011__en-us_topic_0000001942519306_b9304774916">/v2/</strong><em id="apig-api-180713011__en-us_topic_0000001942519306_i4302710494">{project_id}</em><strong id="apig-api-180713011__en-us_topic_0000001942519306_b19304718494">/apigw/instances/</strong><em id="apig-api-180713011__en-us_topic_0000001942519306_i730187124915">{instance_id}</em><strong id="apig-api-180713011__en-us_topic_0000001942519306_b7304744915">/api-groups</strong>. <em id="apig-api-180713011__en-us_topic_0000001942519306_i73010716494">{project_id}</em> indicates a <a href="apig-api-180713009.html#apig-api-180713009">project ID</a> and <em id="apig-api-180713011__en-us_topic_0000001942519306_i113027154915">{instance_id}</em> indicates a gateway ID. The two IDs can be obtained from the gateway information on the APIG console.</li><li id="apig-api-180713011__en-us_topic_0000001942519306_li735905103516"><strong id="apig-api-180713011__en-us_topic_0000001942519306_b133601140195112">query-string</strong>: Query parameter, which is optional. Ensure that a question mark (?) is included in front of each query parameter that is in the format of <em id="apig-api-180713011__en-us_topic_0000001942519306_i1558345512518">Parameter name</em><strong id="apig-api-180713011__en-us_topic_0000001942519306_b1558425515110">=</strong><em id="apig-api-180713011__en-us_topic_0000001942519306_i10584105516516">Parameter value</em>. For example, <strong id="apig-api-180713011__en-us_topic_0000001942519306_b458425545114">limit=10</strong> indicates that a maximum of 10 data records will be queried.</li></ul> <ul id="apig-api-180713011__en-us_topic_0000001942519306_ul63581757356"><li id="apig-api-180713011__en-us_topic_0000001942519306_li183581756359"><strong id="apig-api-180713011__en-us_topic_0000001942519306_b83920310421">URI-scheme</strong>: Protocol used to transmit requests. All APIs use <strong id="apig-api-180713011__en-us_topic_0000001942519306_b539313114215">HTTPS</strong>.</li><li id="apig-api-180713011__en-us_topic_0000001942519306_li16358958354"><strong id="apig-api-180713011__b1799212564406">Endpoint</strong>: Domain name or IP address of the server bearing the REST service. It can be obtained from <a href="apig-api-190529263.html#apig-api-190529263__en-us_topic_0000001969180093_section932113578479">Endpoints</a>. .</li><li id="apig-api-180713011__en-us_topic_0000001942519306_li53597512351"><strong id="apig-api-180713011__en-us_topic_0000001942519306_b31682350472">resource-path</strong>: Access path of an API for performing a specified operation. Obtain the path from the URI of an API. For example, the <strong id="apig-api-180713011__b286407204117">resource-path</strong> of the API used to create an API group is <strong id="apig-api-180713011__b386419734117">/v2/</strong><em id="apig-api-180713011__i18643716412">{project_id}</em><strong id="apig-api-180713011__b18659716416">/apigw/instances/</strong><em id="apig-api-180713011__i18865167144111">{instance_id}</em><strong id="apig-api-180713011__b1686520715411">/api-groups</strong>. <em id="apig-api-180713011__i108651271419">{project_id}</em> indicates a <a href="apig-api-180713009.html">project ID</a> and <em id="apig-api-180713011__i1386517144110">{instance_id}</em> indicates a gateway ID. The two IDs can be obtained from the gateway information on the APIG console.</li><li id="apig-api-180713011__en-us_topic_0000001942519306_li735905103516"><strong id="apig-api-180713011__en-us_topic_0000001942519306_b133601140195112">query-string</strong>: Query parameter, which is optional. Ensure that a question mark (?) is included in front of each query parameter that is in the format of <em id="apig-api-180713011__en-us_topic_0000001942519306_i1558345512518">Parameter name</em><strong id="apig-api-180713011__en-us_topic_0000001942519306_b1558425515110">=</strong><em id="apig-api-180713011__en-us_topic_0000001942519306_i10584105516516">Parameter value</em>. For example, <strong id="apig-api-180713011__en-us_topic_0000001942519306_b458425545114">limit=10</strong> indicates that a maximum of 10 data records will be queried.</li></ul>
<p id="apig-api-180713011__en-us_topic_0000001942519306_p1766380168">For example, if you want to create an API group in a region, set <strong id="apig-api-180713011__en-us_topic_0000001942519306_b17584171219398">URI-scheme</strong> to <strong id="apig-api-180713011__en-us_topic_0000001942519306_b3584141214395">HTTPS</strong>, <strong id="apig-api-180713011__en-us_topic_0000001942519306_b958451233915">Endpoint</strong> to <strong id="apig-api-180713011__en-us_topic_0000001942519306_b12984148114020">apig_endpoint</strong>, and <strong id="apig-api-180713011__en-us_topic_0000001942519306_b10584712183911">resource-path</strong> to <strong id="apig-api-180713011__en-us_topic_0000001942519306_b115841012193914">/v2/{project_id}/apigw/instances/{instance_id}/api-groups</strong>. Combine the parameters in the URI.</p> <p id="apig-api-180713011__en-us_topic_0000001942519306_p1766380168">For example, if you want to create an API group in a region, set <strong id="apig-api-180713011__en-us_topic_0000001942519306_b17584171219398">URI-scheme</strong> to <strong id="apig-api-180713011__en-us_topic_0000001942519306_b3584141214395">HTTPS</strong>, <strong id="apig-api-180713011__en-us_topic_0000001942519306_b958451233915">Endpoint</strong> to <strong id="apig-api-180713011__en-us_topic_0000001942519306_b12984148114020">apig_endpoint</strong>, and <strong id="apig-api-180713011__en-us_topic_0000001942519306_b10584712183911">resource-path</strong> to <strong id="apig-api-180713011__en-us_topic_0000001942519306_b115841012193914">/v2/{project_id}/apigw/instances/{instance_id}/api-groups</strong>. Combine the parameters in the URI.</p>
<pre class="screen" id="apig-api-180713011__en-us_topic_0000001942519306_screen439264613101">https://<em id="apig-api-180713011__en-us_topic_0000001942519306_i16881440175117"><strong id="apig-api-180713011__en-us_topic_0000001942519306_b198810405515">{apig_endpoint}</strong></em>/v2/{project_id}/apigw/instances/{instance_id}/api-groups</pre> <pre class="screen" id="apig-api-180713011__en-us_topic_0000001942519306_screen439264613101">https://<em id="apig-api-180713011__en-us_topic_0000001942519306_i16881440175117"><strong id="apig-api-180713011__en-us_topic_0000001942519306_b198810405515">{apig_endpoint}</strong></em>/v2/{project_id}/apigw/instances/{instance_id}/api-groups</pre>
<div class="note" id="apig-api-180713011__en-us_topic_0000001942519306_note16311253154112"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="apig-api-180713011__en-us_topic_0000001942519306_p163316534416">To simplify the URI display in this document, each API is provided only with a <strong id="apig-api-180713011__en-us_topic_0000001942519306_b762314910439">resource-path</strong> and a request method. The <strong id="apig-api-180713011__en-us_topic_0000001942519306_b6118813104315">URI-scheme</strong> of all APIs is <strong id="apig-api-180713011__en-us_topic_0000001942519306_b7120913164319">HTTPS</strong>, and the endpoints of all APIs in the same region are identical.</p> <div class="note" id="apig-api-180713011__en-us_topic_0000001942519306_note16311253154112"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="apig-api-180713011__en-us_topic_0000001942519306_p163316534416">To simplify the URI display in this document, each API is provided only with a <strong id="apig-api-180713011__en-us_topic_0000001942519306_b762314910439">resource-path</strong> and a request method. The <strong id="apig-api-180713011__en-us_topic_0000001942519306_b6118813104315">URI-scheme</strong> of all APIs is <strong id="apig-api-180713011__en-us_topic_0000001942519306_b7120913164319">HTTPS</strong>, and the endpoints of all APIs in the same region are identical.</p>
@ -29,7 +29,8 @@ Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-ty
<p id="apig-api-180713011__en-us_topic_0000001942519306_p57506215250">Request bodies vary between APIs. Some APIs do not require the request body, such as the APIs requested using the <strong id="apig-api-180713011__en-us_topic_0000001942519306_b12519205617242">GET</strong> and <strong id="apig-api-180713011__en-us_topic_0000001942519306_b1953820586243">DELETE</strong> methods.</p> <p id="apig-api-180713011__en-us_topic_0000001942519306_p57506215250">Request bodies vary between APIs. Some APIs do not require the request body, such as the APIs requested using the <strong id="apig-api-180713011__en-us_topic_0000001942519306_b12519205617242">GET</strong> and <strong id="apig-api-180713011__en-us_topic_0000001942519306_b1953820586243">DELETE</strong> methods.</p>
<p id="apig-api-180713011__en-us_topic_0000001942519306_p675014215258">For the API used to create an API group, you can obtain the request parameters and parameter description from the API request. Here is an example request that includes a body. The bold fields must be configured as required.</p> <p id="apig-api-180713011__en-us_topic_0000001942519306_p675014215258">For the API used to create an API group, you can obtain the request parameters and parameter description from the API request. Here is an example request that includes a body. The bold fields must be configured as required.</p>
<ul id="apig-api-180713011__en-us_topic_0000001942519306_ul1558112914264"><li id="apig-api-180713011__en-us_topic_0000001942519306_li558192962612"><strong id="apig-api-180713011__en-us_topic_0000001942519306_b10316276318">name</strong>: API group name</li><li id="apig-api-180713011__en-us_topic_0000001942519306_li125842952613"><strong id="apig-api-180713011__en-us_topic_0000001942519306_b111225402313">remark</strong>: API group description</li></ul> <ul id="apig-api-180713011__en-us_topic_0000001942519306_ul1558112914264"><li id="apig-api-180713011__en-us_topic_0000001942519306_li558192962612"><strong id="apig-api-180713011__en-us_topic_0000001942519306_b10316276318">name</strong>: API group name</li><li id="apig-api-180713011__en-us_topic_0000001942519306_li125842952613"><strong id="apig-api-180713011__en-us_topic_0000001942519306_b111225402313">remark</strong>: API group description</li></ul>
<pre class="screen" id="apig-api-180713011__en-us_topic_0000001942519306_screen6140617194816">POST https://<em id="apig-api-180713011__en-us_topic_0000001942519306_i4324529339"><strong id="apig-api-180713011__en-us_topic_0000001942519306_b2325192915318">{apig_endpoint}</strong></em>/v2/{project_id}/v2/{project_id}/apigw/instances/{instance_id}/api-groups <pre class="screen" id="apig-api-180713011__en-us_topic_0000001942519306_screen6140617194816">
POST https://<em id="apig-api-180713011__en-us_topic_0000001942519306_i4324529339"><strong id="apig-api-180713011__en-us_topic_0000001942519306_b2325192915318">{apig_endpoint}</strong></em>/v2/{project_id}/v2/{project_id}/apigw/instances/{instance_id}/api-groups
Content-Type: application/json Content-Type: application/json
X-Sdk-Date: 20240416T095341Z X-Sdk-Date: 20240416T095341Z
Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=**************** Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=****************

18
docs/apig/api-ref/apig-api-180713215.html
View File

@ -8,22 +8,10 @@
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="apig-api-180713215__row0928125381012"><td class="cellrowborder" valign="top" width="29.32%" headers="mcps1.3.1.2.3.1.1 "><p id="apig-api-180713215__p9929753111015">2024-12-13</p> <tbody><tr id="apig-api-180713215__row11493163410390"><td class="cellrowborder" valign="top" width="29.32%" headers="mcps1.3.1.2.3.1.1 "><p id="apig-api-180713215__p134941934173916">2024-12-10</p>
</td> </td>
<td class="cellrowborder" valign="top" width="70.67999999999999%" headers="mcps1.3.1.2.3.1.2 "><p id="apig-api-180713215__p29671349113">This issue incorporates the following changes:</p> <td class="cellrowborder" valign="top" width="70.67999999999999%" headers="mcps1.3.1.2.3.1.2 "><p id="apig-api-180713215__p19494193463911">This issue incorporates the following changes:</p>
<ul id="apig-api-180713215__ul228691913119"><li id="apig-api-180713215__li10286101917114">The example response status code of the API for modifying an app is changed from <strong id="apig-api-180713215__b1828661911114">201</strong> to <strong id="apig-api-180713215__b62866195115">200</strong>.</li><li id="apig-api-180713215__li13447181781414">The response status code of the API for modifying the specifications of a pay-per-use gateway is changed from <strong id="apig-api-180713215__b14270247181318">200</strong> to <strong id="apig-api-180713215__b18270194717138">202</strong>.</li></ul> <ul id="apig-api-180713215__ul7811234691"><li id="apig-api-180713215__li19814342919">The response status code of the API for modifying an app is changed from 201 to 200.</li><li id="apig-api-180713215__li7810341998">The response body parameters table of the API for querying the supported features of a Gateway is changed.</li></ul>
</td>
</tr>
<tr id="apig-api-180713215__row18722125144817"><td class="cellrowborder" valign="top" width="29.32%" headers="mcps1.3.1.2.3.1.1 "><p id="apig-api-180713215__p10723825164814">2024-12-10</p>
</td>
<td class="cellrowborder" valign="top" width="70.67999999999999%" headers="mcps1.3.1.2.3.1.2 "><p id="apig-api-180713215__p36313432486">This issue incorporates the following changes:</p>
<ul id="apig-api-180713215__ul42801253912"><li id="apig-api-180713215__li11280202513912">The response status code of the API for modifying an app is changed from <strong id="apig-api-180713215__b163764619482">201</strong> to <strong id="apig-api-180713215__b1673034814810">200</strong>.</li><li id="apig-api-180713215__li628010253919">The response body parameters table of the API for querying the supported features of a gateway is changed.</li></ul>
</td>
</tr>
<tr id="apig-api-180713215__row756664715318"><td class="cellrowborder" valign="top" width="29.32%" headers="mcps1.3.1.2.3.1.1 "><p id="apig-api-180713215__p1956664715311">2024-10-18</p>
</td>
<td class="cellrowborder" valign="top" width="70.67999999999999%" headers="mcps1.3.1.2.3.1.2 "><p id="apig-api-180713215__p161581162047">This issue incorporates the following changes:</p>
<ul id="apig-api-180713215__ul3292105417413"><li id="apig-api-180713215__li229218541247">Updated <a href="apig-api-190529263.html">Before You Start</a>.</li><li id="apig-api-180713215__li129217549410">Optimized <a href="apig-api-180713003.html">Calling APIs</a>.</li><li id="apig-api-180713215__li7693195710420">Added <a href="apig-api-0001.html">API Usage</a>.</li></ul>
</td> </td>
</tr> </tr>
<tr id="apig-api-180713215__en-us_topic_0172451956_row19305205918129"><td class="cellrowborder" valign="top" width="29.32%" headers="mcps1.3.1.2.3.1.1 "><p id="apig-api-180713215__en-us_topic_0172451956_p4306175916123">2024-07-05</p> <tr id="apig-api-180713215__en-us_topic_0172451956_row19305205918129"><td class="cellrowborder" valign="top" width="29.32%" headers="mcps1.3.1.2.3.1.1 "><p id="apig-api-180713215__en-us_topic_0172451956_p4306175916123">2024-07-05</p>

4
docs/apig/api-ref/apig-api-190529263.html
View File

@ -4,7 +4,7 @@
<div id="body8662426"><p id="apig-api-190529263__en-us_topic_0000001969180093_p14359124953115">API Gateway (APIG) is a high-performance, high-availability, and high-security API hosting service that helps enterprises build, manage, and deploy APIs at any scale.</p> <div id="body8662426"><p id="apig-api-190529263__en-us_topic_0000001969180093_p14359124953115">API Gateway (APIG) is a high-performance, high-availability, and high-security API hosting service that helps enterprises build, manage, and deploy APIs at any scale.</p>
<p id="apig-api-190529263__en-us_topic_0000001969180093_p43591949123114">This document describes how to use REST APIs to perform operations on APIG, such as creating, deleting, and modify your own APIs. </p> <p id="apig-api-190529263__en-us_topic_0000001969180093_p43591949123114">This document describes how to use REST APIs to perform operations on APIG, such as creating, deleting, and modify your own APIs. </p>
<p id="apig-api-190529263__en-us_topic_0000001969180093_p33591494313">If you plan to access API Gateway through APIs, ensure that you are familiar with API Gateway concepts. For details, see the <em id="apig-api-190529263__en-us_topic_0000001969180093_i1287581820599">User Guide</em>.</p> <p id="apig-api-190529263__en-us_topic_0000001969180093_p33591494313">If you plan to access API Gateway through APIs, ensure that you are familiar with API Gateway concepts. For details, see the <em id="apig-api-190529263__en-us_topic_0000001969180093_i1287581820599">User Guide</em>.</p>
<div class="section" id="apig-api-190529263__en-us_topic_0000001969180093_section932113578479"><h4 class="sectiontitle">Endpoints</h4><p id="apig-api-190529263__en-us_topic_0000001969180093_p14210164262711">An endpoint is the <strong id="apig-api-190529263__en-us_topic_0000001969180093_b121007380415">request address</strong> for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, contact technical support engineers.</p> <div class="section" id="apig-api-190529263__en-us_topic_0000001969180093_section932113578479"><a name="apig-api-190529263__en-us_topic_0000001969180093_section932113578479"></a><a name="en-us_topic_0000001969180093_section932113578479"></a><h4 class="sectiontitle">Endpoints</h4><p id="apig-api-190529263__en-us_topic_0000001969180093_p14210164262711">An endpoint is the <strong id="apig-api-190529263__en-us_topic_0000001969180093_b121007380415">request address</strong> for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, contact technical support engineers.</p>
</div> </div>
<div class="section" id="apig-api-190529263__en-us_topic_0000001969180093_section4575182612554"><h4 class="sectiontitle">Concepts</h4><ul id="apig-api-190529263__en-us_topic_0000001969180093_ul1351921410566"><li id="apig-api-190529263__en-us_topic_0000001969180093_li7519171455619">Account<p id="apig-api-190529263__en-us_topic_0000001969180093_p15520201418569"><a name="apig-api-190529263__en-us_topic_0000001969180093_li7519171455619"></a><a name="en-us_topic_0000001969180093_li7519171455619"></a>An account is created upon successful registration. The account has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The account is a payment entity and should not be used directly to perform routine management. For security purposes, create IAM users and grant them permissions for routine management.</p> <div class="section" id="apig-api-190529263__en-us_topic_0000001969180093_section4575182612554"><h4 class="sectiontitle">Concepts</h4><ul id="apig-api-190529263__en-us_topic_0000001969180093_ul1351921410566"><li id="apig-api-190529263__en-us_topic_0000001969180093_li7519171455619">Account<p id="apig-api-190529263__en-us_topic_0000001969180093_p15520201418569"><a name="apig-api-190529263__en-us_topic_0000001969180093_li7519171455619"></a><a name="en-us_topic_0000001969180093_li7519171455619"></a>An account is created upon successful registration. The account has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The account is a payment entity and should not be used directly to perform routine management. For security purposes, create IAM users and grant them permissions for routine management.</p>
</li><li id="apig-api-190529263__en-us_topic_0000001969180093_li105201614195610">IAM user<p id="apig-api-190529263__en-us_topic_0000001969180093_p75201140563"><a name="apig-api-190529263__en-us_topic_0000001969180093_li105201614195610"></a><a name="en-us_topic_0000001969180093_li105201614195610"></a>A user is created using a domain to use cloud services. Each user has its own identity credentials (password and access keys).</p> </li><li id="apig-api-190529263__en-us_topic_0000001969180093_li105201614195610">IAM user<p id="apig-api-190529263__en-us_topic_0000001969180093_p75201140563"><a name="apig-api-190529263__en-us_topic_0000001969180093_li105201614195610"></a><a name="en-us_topic_0000001969180093_li105201614195610"></a>A user is created using a domain to use cloud services. Each user has its own identity credentials (password and access keys).</p>
@ -13,7 +13,7 @@
<p id="apig-api-190529263__en-us_topic_0000001969180093_p85206147565">For details, see <span class="wintitle" id="apig-api-190529263__en-us_topic_0000001969180093_wintitle8100142544718"><b>Help Center &gt; Others &gt; FAQs &gt; Regions and AZs</b></span>.</p> <p id="apig-api-190529263__en-us_topic_0000001969180093_p85206147565">For details, see <span class="wintitle" id="apig-api-190529263__en-us_topic_0000001969180093_wintitle8100142544718"><b>Help Center &gt; Others &gt; FAQs &gt; Regions and AZs</b></span>.</p>
</li><li id="apig-api-190529263__en-us_topic_0000001969180093_li9520111405611">Availability zone (AZ)<p id="apig-api-190529263__en-us_topic_0000001969180093_p78805519575"><a name="apig-api-190529263__en-us_topic_0000001969180093_li9520111405611"></a><a name="en-us_topic_0000001969180093_li9520111405611"></a>An Availability Zone (AZ) contains one or more physical data centers. Each AZ has independent cooling, fire extinguishing, moisture-proof, and electricity facilities. Within an AZ, compute, network, storage, and other resources are logically divided into multiple clusters. AZs within a region are interconnected using high-speed optical fibers to support cross-AZ high-availability systems.</p> </li><li id="apig-api-190529263__en-us_topic_0000001969180093_li9520111405611">Availability zone (AZ)<p id="apig-api-190529263__en-us_topic_0000001969180093_p78805519575"><a name="apig-api-190529263__en-us_topic_0000001969180093_li9520111405611"></a><a name="en-us_topic_0000001969180093_li9520111405611"></a>An Availability Zone (AZ) contains one or more physical data centers. Each AZ has independent cooling, fire extinguishing, moisture-proof, and electricity facilities. Within an AZ, compute, network, storage, and other resources are logically divided into multiple clusters. AZs within a region are interconnected using high-speed optical fibers to support cross-AZ high-availability systems.</p>
</li><li id="apig-api-190529263__en-us_topic_0000001969180093_li55206149566">Project<p id="apig-api-190529263__en-us_topic_0000001969180093_p95201914145618"><a name="apig-api-190529263__en-us_topic_0000001969180093_li55206149566"></a><a name="en-us_topic_0000001969180093_li55206149566"></a>Projects group and isolate resources (including compute, storage, and network resources) across physical regions. A default project is provided for each region, and subprojects can be created under each default project. Users can be granted permissions to access all resources in a specific project. If you need more refined access control, create subprojects under a default project and create resources in subprojects. Then you can assign users the permissions required to access only the resources in the specific subprojects.</p> </li><li id="apig-api-190529263__en-us_topic_0000001969180093_li55206149566">Project<p id="apig-api-190529263__en-us_topic_0000001969180093_p95201914145618"><a name="apig-api-190529263__en-us_topic_0000001969180093_li55206149566"></a><a name="en-us_topic_0000001969180093_li55206149566"></a>Projects group and isolate resources (including compute, storage, and network resources) across physical regions. A default project is provided for each region, and subprojects can be created under each default project. Users can be granted permissions to access all resources in a specific project. If you need more refined access control, create subprojects under a default project and create resources in subprojects. Then you can assign users the permissions required to access only the resources in the specific subprojects.</p>
<div class="fignone" id="apig-api-190529263__en-us_topic_0000001969180093_fig1152020149565"><span class="figcap"><b>Figure 1 </b>Project isolating model</span><br><span><img id="apig-api-190529263__en-us_topic_0000001969180093_image1656141374811" src="en-us_image_0000001988900321.png"></span></div> <div class="fignone" id="apig-api-190529263__en-us_topic_0000001969180093_fig1152020149565"><span class="figcap"><b>Figure 1 </b>Project isolating model</span><br><span><img id="apig-api-190529263__en-us_topic_0000001969180093_image1656141374811" src="en-us_image_0000002120347354.png"></span></div>
<p id="apig-api-190529263__en-us_topic_0000001969180093_p102014374598">An IAM user can view the project ID on the <strong id="apig-api-190529263__en-us_topic_0000001969180093_b117851859161">My Credentials</strong> page of the console.</p> <p id="apig-api-190529263__en-us_topic_0000001969180093_p102014374598">An IAM user can view the project ID on the <strong id="apig-api-190529263__en-us_topic_0000001969180093_b117851859161">My Credentials</strong> page of the console.</p>
</li></ul> </li></ul>
<ul id="apig-api-190529263__en-us_topic_0000001969180093_ul155211514145611"><li id="apig-api-190529263__en-us_topic_0000001969180093_li185211214125619">Enterprise project<p id="apig-api-190529263__en-us_topic_0000001969180093_p95211114175614"><a name="apig-api-190529263__en-us_topic_0000001969180093_li185211214125619"></a><a name="en-us_topic_0000001969180093_li185211214125619"></a>Enterprise projects group and manage resources across regions. Resources in different enterprise projects are logically isolated. An enterprise project can contain resources of multiple regions, and resources can be added to or removed from enterprise projects.</p> <ul id="apig-api-190529263__en-us_topic_0000001969180093_ul155211514145611"><li id="apig-api-190529263__en-us_topic_0000001969180093_li185211214125619">Enterprise project<p id="apig-api-190529263__en-us_topic_0000001969180093_p95211114175614"><a name="apig-api-190529263__en-us_topic_0000001969180093_li185211214125619"></a><a name="en-us_topic_0000001969180093_li185211214125619"></a>Enterprise projects group and manage resources across regions. Resources in different enterprise projects are logically isolated. An enterprise project can contain resources of multiple regions, and resources can be added to or removed from enterprise projects.</p>

30
docs/apig/api-ref/apig-api-190529268.html
View File

@ -4,29 +4,25 @@
<div id="body8662426"><p id="apig-api-190529268__en-us_topic_0172440411_p26613555143846">Requests for calling an API can be authenticated using either of the following methods:</p> <div id="body8662426"><p id="apig-api-190529268__en-us_topic_0172440411_p26613555143846">Requests for calling an API can be authenticated using either of the following methods:</p>
<ul id="apig-api-190529268__en-us_topic_0172440411_ul38195410143846"><li id="apig-api-190529268__en-us_topic_0172440411_li61384639143846">AK/SK-based authentication: Requests are authenticated by encrypting the request body using an AK/SK pair. AK/SK-based authentication is recommended because it provides higher security than token-based authentication. </li><li id="apig-api-190529268__en-us_topic_0172440411_li8214375143846">Token-based authentication: Requests are authenticated using a token.<p id="apig-api-190529268__en-us_topic_0172440411_p97292269311"><a name="apig-api-190529268__en-us_topic_0172440411_li8214375143846"></a><a name="en-us_topic_0172440411_li8214375143846"></a></p> <ul id="apig-api-190529268__en-us_topic_0172440411_ul38195410143846"><li id="apig-api-190529268__en-us_topic_0172440411_li61384639143846">AK/SK-based authentication: Requests are authenticated by encrypting the request body using an AK/SK pair. AK/SK-based authentication is recommended because it provides higher security than token-based authentication. </li><li id="apig-api-190529268__en-us_topic_0172440411_li8214375143846">Token-based authentication: Requests are authenticated using a token.<p id="apig-api-190529268__en-us_topic_0172440411_p97292269311"><a name="apig-api-190529268__en-us_topic_0172440411_li8214375143846"></a><a name="en-us_topic_0172440411_li8214375143846"></a></p>
</li></ul> </li></ul>
<div class="section" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_section0390282152"><h4 class="sectiontitle">AK/SK-based Authentication</h4><p id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_p5607113161512">An AK/SK is used to verify the identity of a request sender. In AK/SK-based authentication, a signature needs to be obtained and then added to requests.</p> <div class="section" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_section0390282152"><a name="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_section0390282152"></a><a name="en-us_topic_0172440411_en-us_topic_0121671869_section0390282152"></a><h4 class="sectiontitle">AK/SK-based Authentication</h4><p id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_p5607113161512">An AK/SK is used to verify the identity of a request sender. In AK/SK-based authentication, a signature needs to be obtained and then added to requests.</p>
<div class="note" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_n9dcbfe6b240a43cfa48bb67f6e4b0126"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_a9057158d9de6408fb6d7843353d9b3aa">AK: access key ID, which is a unique identifier used in conjunction with a secret access key to sign requests cryptographically.</p> <ul id="apig-api-190529268__ul34615082010"><li id="apig-api-190529268__li1461206205">AK: access key ID, which is a unique identifier used with a secret access key to sign requests cryptographically.</li><li id="apig-api-190529268__li846119011206">SK: secret access key used in conjunction with an AK to sign requests cryptographically. It identifies a request sender and prevents the request from being modified.</li></ul>
<p id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_a6b8f717e84924432b9b93893ca4141c1">SK: secret access key used in conjunction with an AK to sign requests cryptographically. It identifies a request sender and prevents the request from being modified.</p>
</div></div>
<p id="apig-api-190529268__en-us_topic_0172440411_p15997957182616">The following uses a demo project to show how to sign a request and use an HTTP client to send an HTTPS request.</p> <p id="apig-api-190529268__en-us_topic_0172440411_p15997957182616">The following uses a demo project to show how to sign a request and use an HTTP client to send an HTTPS request.</p>
<p id="apig-api-190529268__en-us_topic_0172440411_p11261977377">Download the demo project at <a href="https://github.com/api-gate-way/SdkDemo" target="_blank" rel="noopener noreferrer">https://github.com/api-gate-way/SdkDemo</a>.</p> <p id="apig-api-190529268__en-us_topic_0172440411_p11261977377">Download the demo project at <a href="https://github.com/api-gate-way/SdkDemo" target="_blank" rel="noopener noreferrer">https://github.com/api-gate-way/SdkDemo</a>.</p>
<p id="apig-api-190529268__en-us_topic_0172440411_p19468322103716">If you do not need the demo, obtain the APIG signing SDK from technical support personnel.</p> <p id="apig-api-190529268__en-us_topic_0172440411_p19468322103716">If you do not need the demo, obtain the APIG signing SDK from technical support personnel.</p>
<p id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_p1656604461617">AK: access key ID, which is a unique identifier used in conjunction with a secret access key to sign requests cryptographically.</p> <p id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_p1656604461617">Decompress the downloaded package and reference the obtained JAR file as a dependency.</p>
<div class="fignone" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_fig919329144115"><span class="figcap"><b>Figure 1 </b>Adding the APIG signing SDK</span><br><span><img id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_image174116208156" src="en-us_image_0173593322.png"></span></div> <div class="fignone" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_fig919329144115"><span class="figcap"><b>Figure 1 </b>Adding the APIG signing SDK</span><br><span><img id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_image174116208156" src="en-us_image_0000002155592541.png"></span></div>
<ol id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_ol18692431181510"><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li039995792416"><span>Generate an AK/SK. (If an AK/SK file has already been obtained, skip this step and locate the downloaded AK/SK file. Generally, the file name will be <strong id="apig-api-190529268__en-us_topic_0172440411_b208892054103419">credentials.csv</strong>.)</span><p><ol type="a" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_ol1041165715248"><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li641635711249">Register an account and log in to the management console.</li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li15426115710241">Hover over the username and choose <strong id="apig-api-190529268__en-us_topic_0172440411_b1331310311386">My Credentials</strong> from the drop-down list.</li></ol><ol type="a" start="3" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_ol4435175711246"><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li94401457192414">Choose <strong id="apig-api-190529268__en-us_topic_0172440411_b6484124314610">Access Keys</strong> from the navigation pane.</li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li4446115712243">Click <strong id="apig-api-190529268__en-us_topic_0172440411_b1766935216311">Create Access Key</strong>.</li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li1645475712241">Enter the login password.</li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li546365716247">Enter the verification code received by email or SMS message.<div class="note" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_note12481175762411"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p class="text" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_p249925712416">For users created in IAM that have not bound any email address or mobile number, only the login password needs to be entered.</p> <ol id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_ol18692431181510"><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li039995792416"><span>Generate an AK/SK. (If an AK/SK file has already been obtained, skip this step and locate the downloaded AK/SK file. Generally, the file name will be <strong id="apig-api-190529268__en-us_topic_0172440411_b208892054103419">credentials.csv</strong>.)</span><p><ol type="a" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_ol1041165715248"><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li641635711249">Register an account and log in to the management console.</li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li15426115710241">Hover over the username and choose <strong id="apig-api-190529268__en-us_topic_0172440411_b1331310311386">My Credentials</strong> from the drop-down list.</li></ol><ol type="a" start="3" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_ol4435175711246"><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li94401457192414">Choose <strong id="apig-api-190529268__en-us_topic_0172440411_b6484124314610">Access Keys</strong> from the navigation pane.</li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li4446115712243">Click <strong id="apig-api-190529268__en-us_topic_0172440411_b1766935216311">Create Access Key</strong>.</li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li1645475712241">Enter the login password.</li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li546365716247">Enter the verification code received by email or SMS message.<div class="note" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_note12481175762411"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p class="text" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_p249925712416">For users created in IAM that have not bound any email address or mobile number, only the login password needs to be entered.</p>
</div></div> </div></div>
</li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li20543057142412">Click <strong id="apig-api-190529268__en-us_topic_0172440411_b114935414311">OK</strong> to download the access key.<div class="note" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_note35511957122417"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p class="text" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_p3570155782420">Keep the access key secure.</p> </li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li20543057142412">Click <strong id="apig-api-190529268__en-us_topic_0172440411_b114935414311">OK</strong> to download the access key. <strong id="apig-api-190529268__b6767153815544">Keep the access key secure.</strong></li></ol>
</div></div> </p></li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li1115311720450"><span>Download and decompress the demo project.</span></li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li19564155663214"><a name="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li19564155663214"></a><a name="en-us_topic_0172440411_en-us_topic_0121671869_li19564155663214"></a><span>Import the demo project to Eclipse.</span><p><div class="fignone" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_fig16546145205014"><span class="figcap"><b>Figure 2 </b>Selecting Existing Projects into Workspace</span><br><span><img id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_image1474131114720" src="en-us_image_0000002120352414.png"></span></div>
</li></ol> <div class="fignone" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_fig767232218519"><span class="figcap"><b>Figure 3 </b>Selecting the demo project</span><br><span><img id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_image13419842205018" src="en-us_image_0000002120194306.png"></span></div>
</p></li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li1115311720450"><span>Download and decompress the demo project.</span></li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li19564155663214"><a name="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li19564155663214"></a><a name="en-us_topic_0172440411_en-us_topic_0121671869_li19564155663214"></a><span>Import the demo project to Eclipse.</span><p><div class="fignone" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_fig16546145205014"><span class="figcap"><b>Figure 2 </b>Selecting Existing Projects into Workspace</span><br><span><img id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_image1474131114720" src="en-us_image_0173593323.png"></span></div> <div class="fignone" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_fig159778103242"><span class="figcap"><b>Figure 4 </b>Structure of the demo project</span><br><span><img id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_image128044312389" src="en-us_image_0000002155714161.png"></span></div>
<div class="fignone" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_fig767232218519"><span class="figcap"><b>Figure 3 </b>Selecting the demo project</span><br><span><img id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_image13419842205018" src="en-us_image_0173593324.png"></span></div>
<div class="fignone" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_fig159778103242"><span class="figcap"><b>Figure 4 </b>Structure of the demo project</span><br><span><img id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_image128044312389" src="en-us_image_0173593326.png"></span></div>
</p></li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li878093111517"><span>Sign the request.</span><p><p id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_p10940124322710">The request signing method is integrated in the JAR files imported in <a href="#apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li19564155663214">3</a>. The request needs to be signed before it is sent. The signature will then be added as part of the HTTP header to the request.</p> </p></li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li878093111517"><span>Sign the request.</span><p><p id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_p10940124322710">The request signing method is integrated in the JAR files imported in <a href="#apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li19564155663214">3</a>. The request needs to be signed before it is sent. The signature will then be added as part of the HTTP header to the request.</p>
<p id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_p979243115158">The demo code is classified into the following classes to demonstrate signing and sending the HTTP request:</p> <p id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_p979243115158">The demo code is classified into the following classes to demonstrate signing and sending the HTTP request:</p>
<ul id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_ul46077243144336"><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li373103144336"><strong id="apig-api-190529268__en-us_topic_0172440411_b118932035103413">AccessService</strong>: an abstract class that merges the GET, POST, PUT, and DELETE methods into the access method.</li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li15119103144339"><strong id="apig-api-190529268__en-us_topic_0172440411_b199517574414">Demo</strong>: Execution entry used to simulate the sending of GET, POST, PUT, and DELETE requests.</li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li54381430144341"><strong id="apig-api-190529268__en-us_topic_0172440411_b739815754210">AccessServiceImpl</strong>: Implements the access method, which contains the code required for communication with APIG.</li></ul> <ul id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_ul46077243144336"><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li373103144336"><strong id="apig-api-190529268__en-us_topic_0172440411_b118932035103413">AccessService</strong>: an abstract class that merges the GET, POST, PUT, and DELETE methods into the access method.</li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li15119103144339"><strong id="apig-api-190529268__en-us_topic_0172440411_b199517574414">Demo</strong>: Execution entry used to simulate the sending of GET, POST, PUT, and DELETE requests.</li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li54381430144341"><strong id="apig-api-190529268__en-us_topic_0172440411_b739815754210">AccessServiceImpl</strong>: Implements the access method, which contains the code required for communication with APIG.</li></ul>
<ol type="a" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_ol1515318170459"><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li1985133317503">Edit the main() method in the <strong id="apig-api-190529268__en-us_topic_0172440411_b1644717515392">Demo.java</strong> file, and replace the bold text with actual values.<p id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_p2061535616161">As shown in the following code, if you use other methods such as POST, PUT, and DELETE, see the corresponding comment.</p> <ol type="a" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_ol1515318170459"><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li1985133317503">Edit the main() method in the <strong id="apig-api-190529268__en-us_topic_0172440411_b1644717515392">Demo.java</strong> file, and replace the bold text with actual values.<p id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_p2061535616161">As shown in the following code, if you use other methods such as POST, PUT, and DELETE, see the corresponding comment.</p>
<p id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_p129401344175213">Specify <strong id="apig-api-190529268__en-us_topic_0172440411_b2642123633911">region</strong>, <strong id="apig-api-190529268__en-us_topic_0172440411_b7960183753910">serviceName</strong>, <strong id="apig-api-190529268__en-us_topic_0172440411_b7975103917398">ak/sk</strong>, and <strong id="apig-api-190529268__en-us_topic_0172440411_b12744542143916">url</strong> as the actual values. In this demo, the URLs for accessing VPC resources are used.</p> <p id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_p129401344175213">Specify <strong id="apig-api-190529268__en-us_topic_0172440411_b2642123633911">region</strong>, <strong id="apig-api-190529268__en-us_topic_0172440411_b7960183753910">serviceName</strong>, <strong id="apig-api-190529268__en-us_topic_0172440411_b7975103917398">ak/sk</strong>, and <strong id="apig-api-190529268__en-us_topic_0172440411_b12744542143916">url</strong> as the actual values. In this demo, the URLs for accessing VPC resources are used.</p>
<p id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_p27531945173720">To obtain the project ID in the URLs, see <a href="apig-api-180713009.html#apig-api-180713009">Obtaining a Project ID</a>. To obtain the endpoint, contact the enterprise administrator.</p> <p id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_p27531945173720">To obtain the project ID in the URLs, see <a href="apig-api-180713009.html">Obtaining a Project ID</a>. To obtain the endpoint, contact the enterprise administrator.</p>
<pre class="screen" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_screen89816540225">//<strong id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_b6201155152216">TODO</strong>: Replace region with the name of the region in which the service to be accessed is located. <pre class="screen" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_screen89816540225">//<strong id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_b6201155152216">TODO</strong>: Replace region with the name of the region in which the service to be accessed is located.
<strong id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_b17211255162214">private</strong> <strong id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_b152115532218">static</strong> <strong id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_b1121105522215">final</strong> String <strong id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_b5213558226"><em id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_i2211455112218">region</em></strong> = ""; <strong id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_b17211255162214">private</strong> <strong id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_b152115532218">static</strong> <strong id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_b1121105522215">final</strong> String <strong id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_b5213558226"><em id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_i2211455112218">region</em></strong> = "";
@ -70,10 +66,10 @@ String url = "<strong id="apig-api-190529268__en-us_topic_0172440411_en-us_topic
</li></ol> </li></ol>
</p></li></ol> </p></li></ol>
</div> </div>
<div class="section" id="apig-api-190529268__en-us_topic_0172440411_section2417768214391"><h4 class="sectiontitle">Token-based Authentication</h4><div class="note" id="apig-api-190529268__en-us_topic_0172440411_note133321911123"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="apig-api-190529268__en-us_topic_0172440411_ul1811111515204"><li id="apig-api-190529268__en-us_topic_0172440411_li515275492018">The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API used to obtain a user token.</li><li id="apig-api-190529268__en-us_topic_0172440411_li1111051162020">Ensure that the token is valid when you use it. Using a token that will soon expire may cause API calling failures.</li></ul> <div class="section" id="apig-api-190529268__en-us_topic_0172440411_section2417768214391"><h4 class="sectiontitle">Token-based Authentication</h4><div class="notice" id="apig-api-190529268__note184901082218"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><ul id="apig-api-190529268__en-us_topic_0172440411_ul1811111515204"><li id="apig-api-190529268__en-us_topic_0172440411_li515275492018">The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API used to obtain a user token.</li><li id="apig-api-190529268__en-us_topic_0172440411_li1111051162020">Ensure that the token is valid when you use it. Using a token that will soon expire may cause API calling failures.</li></ul>
</div></div> </div></div>
<p id="apig-api-190529268__en-us_topic_0172440411_p18703477214">A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to requests to get permissions for calling the API.</p> <p id="apig-api-190529268__en-us_topic_0172440411_p18703477214">A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to requests to get permissions for calling the API.</p>
<p id="apig-api-190529268__en-us_topic_0172440411_p7715203712228">When calling an API to obtain a user token, you must set <strong id="apig-api-190529268__en-us_topic_0172440411_b15281131314375">auth.scope</strong> in the request body to <strong id="apig-api-190529268__en-us_topic_0172440411_b16667169193710">project</strong>.</p> <p id="apig-api-190529268__en-us_topic_0172440411_p7715203712228">When calling an API to obtain a user token, you must set <strong id="apig-api-190529268__b1699975817464">auth.scope</strong> in the request body to <strong id="apig-api-190529268__b6045917468">project</strong>.</p>
<pre class="screen" id="apig-api-190529268__en-us_topic_0172440411_screen771517374228">{ <pre class="screen" id="apig-api-190529268__en-us_topic_0172440411_screen771517374228">{
"auth": { "auth": {
"identity": { "identity": {
@ -97,11 +93,11 @@ String url = "<strong id="apig-api-190529268__en-us_topic_0172440411_en-us_topic
<strong id="apig-api-190529268__en-us_topic_0172440411_b1071633722218"> }</strong> <strong id="apig-api-190529268__en-us_topic_0172440411_b1071633722218"> }</strong>
} }
}</pre> }</pre>
<p id="apig-api-190529268__en-us_topic_0172440411_p9691122114266">After a token is obtained, the <strong id="apig-api-190529268__en-us_topic_0172440411_b1989511293228">X-Auth-Token</strong> header field must be added to requests to specify the token when calling other APIs. For example, if the token is <strong id="apig-api-190529268__en-us_topic_0172440411_b557119459221">ABCDEFJ....</strong>, <strong id="apig-api-190529268__en-us_topic_0172440411_b15689948152216">X-Auth-Token: ABCDEFJ....</strong> can be added to a request as follows:</p> <p id="apig-api-190529268__en-us_topic_0172440411_p9691122114266">After a token is obtained, the <strong id="apig-api-190529268__en-us_topic_0172440411_b1989511293228">X-Auth-Token</strong> header field must be added to requests to specify the token when calling other APIs. For example, if the token is <span class="parmvalue" id="apig-api-190529268__parmvalue151511509464"><b>ABCDEFG....</b></span>, <span class="parmvalue" id="apig-api-190529268__parmvalue11511407462"><b>X-Auth-Token: ABCDEFG....</b></span> can be added to a request as follows:</p>
<pre class="screen" id="apig-api-190529268__en-us_topic_0172440411_screen11189101154015"> <pre class="screen" id="apig-api-190529268__en-us_topic_0172440411_screen11189101154015">
POST https://<em id="apig-api-190529268__en-us_topic_0172440411_i4324529339"><strong id="apig-api-190529268__en-us_topic_0172440411_b2325192915318">{apig_endpoint}</strong></em>/v2/{project_id}/v2/{project_id}/apigw/instances/{instance_id}/api-groups POST https://<em id="apig-api-190529268__en-us_topic_0172440411_i4324529339"><strong id="apig-api-190529268__en-us_topic_0172440411_b2325192915318">{apig_endpoint}</strong></em>/v2/{project_id}/v2/{project_id}/apigw/instances/{instance_id}/api-groups
Content-Type: application/json Content-Type: application/json
<strong id="apig-api-190529268__en-us_topic_0172440411_b172853338430">X-Auth-Token: ABCDEFJ....</strong></pre> <strong id="apig-api-190529268__en-us_topic_0172440411_b172853338430">X-Auth-Token: ABCDEFG....</strong></pre>
</div> </div>
</div> </div>
<div> <div>

4
docs/apig/api-ref/apig-api-190529269.html
View File

@ -2,12 +2,12 @@
<h1 class="topictitle1">Response</h1> <h1 class="topictitle1">Response</h1>
<div id="body8662426"><p id="apig-api-190529269__en-us_topic_0172440412_p4624111624411">After sending a request, you will receive a response, including a status code, response header, and response body.</p> <div id="body8662426"><p id="apig-api-190529269__en-us_topic_0172440412_p4624111624411">After sending a request, you will receive a response, including a status code, response header, and response body.</p>
<div class="section" id="apig-api-190529269__en-us_topic_0172440412_section968114282311"><h4 class="sectiontitle">Status Code</h4><p id="apig-api-190529269__en-us_topic_0172440412_p124381044137">A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see <a href="apig-api-180713206.html#apig-api-180713206">HTTP Status Codes</a>.</p> <div class="section" id="apig-api-190529269__en-us_topic_0172440412_section968114282311"><h4 class="sectiontitle">Status Code</h4><p id="apig-api-190529269__en-us_topic_0172440412_p124381044137">A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see <a href="apig-api-180713206.html">HTTP Status Codes</a>.</p>
<p id="apig-api-190529269__en-us_topic_0172440412_p2861496519">For example, if status code <strong id="apig-api-190529269__en-us_topic_0172440412_b1944618526549">201</strong> is returned for calling the API used to create an API group, the request is successful.</p> <p id="apig-api-190529269__en-us_topic_0172440412_p2861496519">For example, if status code <strong id="apig-api-190529269__en-us_topic_0172440412_b1944618526549">201</strong> is returned for calling the API used to create an API group, the request is successful.</p>
</div> </div>
<div class="section" id="apig-api-190529269__en-us_topic_0172440412_section7804143005810"><h4 class="sectiontitle">Response Header</h4><p id="apig-api-190529269__en-us_topic_0172440412_p384320471837">Similar to a request, a response also has a header, for example, <strong id="apig-api-190529269__en-us_topic_0172440412_b3428039105210">Content-Type</strong>.</p> <div class="section" id="apig-api-190529269__en-us_topic_0172440412_section7804143005810"><h4 class="sectiontitle">Response Header</h4><p id="apig-api-190529269__en-us_topic_0172440412_p384320471837">Similar to a request, a response also has a header, for example, <strong id="apig-api-190529269__en-us_topic_0172440412_b3428039105210">Content-Type</strong>.</p>
<p id="apig-api-190529269__en-us_topic_0172440412_p586212517238">For example, when calling the API used to create an API group (dedicated gateways), the response headers are shown below.</p> <p id="apig-api-190529269__en-us_topic_0172440412_p586212517238">For example, when calling the API used to create an API group (dedicated gateways), the response headers are shown below.</p>
<div class="fignone" id="apig-api-190529269__en-us_topic_0172440412_fig11253355175215"><span class="figcap"><b>Figure 1 </b>Response headers for creating an API group</span><br><span><img id="apig-api-190529269__en-us_topic_0172440412_image4904194084419" src="en-us_image_0000001892790552.png"></span></div> <div class="fignone" id="apig-api-190529269__en-us_topic_0172440412_fig11253355175215"><span class="figcap"><b>Figure 1 </b>Response headers for creating an API group</span><br><span><img id="apig-api-190529269__en-us_topic_0172440412_image4904194084419" src="en-us_image_0000002155592549.png"></span></div>
</div> </div>
<div class="section" id="apig-api-190529269__en-us_topic_0172440412_section034615592583"><h4 class="sectiontitle">Response Body</h4><p id="apig-api-190529269__en-us_topic_0172440412_p133921631940">The body of a response is often returned in structured format as specified in the <strong id="apig-api-190529269__en-us_topic_0172440412_b205653394539">Content-Type</strong> header field. The response body transfers content except the response header.</p> <div class="section" id="apig-api-190529269__en-us_topic_0172440412_section034615592583"><h4 class="sectiontitle">Response Body</h4><p id="apig-api-190529269__en-us_topic_0172440412_p133921631940">The body of a response is often returned in structured format as specified in the <strong id="apig-api-190529269__en-us_topic_0172440412_b205653394539">Content-Type</strong> header field. The response body transfers content except the response header.</p>
<p id="apig-api-190529269__en-us_topic_0172440412_p157041652367">The following is part of the response body for the API used to create an API group.</p> <p id="apig-api-190529269__en-us_topic_0172440412_p157041652367">The following is part of the response body for the API used to create an API group.</p>

3
docs/apig/api-ref/apig-api-190529271.html
View File

@ -1,8 +1,11 @@
<a name="apig-api-190529271"></a><a name="apig-api-190529271"></a> <a name="apig-api-190529271"></a><a name="apig-api-190529271"></a>
<h1 class="topictitle1">Appendix</h1> <h1 class="topictitle1">Appendix</h1>
<div id="body8662426"><p id="apig-api-190529271__en-us_topic_0172449253_p8060118"></p> <div id="body8662426"><p id="apig-api-190529271__en-us_topic_0172449253_p8060118"></p>
</div> </div>
<div> <div>
<ul class="ullinks"> <ul class="ullinks">
<li class="ulchildlink"><strong><a href="apig-api-180713204.html">Pagination Query</a></strong><br> <li class="ulchildlink"><strong><a href="apig-api-180713204.html">Pagination Query</a></strong><br>

21
docs/apig/api-ref/apig-api-20200402.html
View File

@ -1,7 +1,7 @@
<a name="apig-api-20200402"></a><a name="apig-api-20200402"></a> <a name="apig-api-20200402"></a><a name="apig-api-20200402"></a>
<h1 class="topictitle1">Supported Features</h1> <h1 class="topictitle1">Supported Features</h1>
<div id="body32001227"><p id="apig-api-20200402__en-us_topic_0000001143328897_p207271902710">The following table lists the features that are supported by <strong id="apig-api-20200402__en-us_topic_0000001143328897_b105351432182619">dedicated gateways</strong>.</p> <div id="body8662426"><p id="apig-api-20200402__en-us_topic_0000001143328897_p207271902710">The following table lists the features that are supported by <strong id="apig-api-20200402__en-us_topic_0000001143328897_b105351432182619">dedicated gateways</strong>.</p>
<div class="note" id="apig-api-20200402__en-us_topic_0000001143328897_en-us_topic_0281057028_note34931951184916"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="apig-api-20200402__en-us_topic_0000001143328897_en-us_topic_0281057028_p1749305104912">If the gateway you use does not have specific features, contact technical support to upgrade your gateway.</p> <div class="note" id="apig-api-20200402__en-us_topic_0000001143328897_en-us_topic_0281057028_note34931951184916"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="apig-api-20200402__en-us_topic_0000001143328897_en-us_topic_0281057028_p1749305104912">If the gateway you use does not have specific features, contact technical support to upgrade your gateway.</p>
</div></div> </div></div>
@ -25,7 +25,7 @@
</thead> </thead>
<tbody><tr id="apig-api-20200402__en-us_topic_0000001143328897_en-us_topic_0281057028_row128492810369"><td class="cellrowborder" rowspan="4" valign="top" width="13.671367136713672%" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20200402__en-us_topic_0000001143328897_en-us_topic_0281057028_p1029016288362">lts</p> <tbody><tr id="apig-api-20200402__en-us_topic_0000001143328897_en-us_topic_0281057028_row128492810369"><td class="cellrowborder" rowspan="4" valign="top" width="13.671367136713672%" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20200402__en-us_topic_0000001143328897_en-us_topic_0281057028_p1029016288362">lts</p>
</td> </td>
<td class="cellrowborder" rowspan="4" valign="top" width="10.551055105510551%" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20200402__en-us_topic_0000001143328897_en-us_topic_0281057028_p12901282361">Reporting of Shubao access logs</p> <td class="cellrowborder" rowspan="4" valign="top" width="10.551055105510551%" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20200402__en-us_topic_0000001143328897_en-us_topic_0281057028_p12901282361">Reporting of APIG gateway node access logs</p>
</td> </td>
<td class="cellrowborder" rowspan="4" valign="top" width="10.99109910991099%" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20200402__en-us_topic_0000001143328897_en-us_topic_0281057028_p936943354616">Yes</p> <td class="cellrowborder" rowspan="4" valign="top" width="10.99109910991099%" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20200402__en-us_topic_0000001143328897_en-us_topic_0281057028_p936943354616">Yes</p>
</td> </td>
@ -836,23 +836,6 @@
<td class="cellrowborder" valign="top" width="13.211321132113213%" headers="mcps1.3.3.1.9.1.8 "><p id="apig-api-20200402__en-us_topic_0000001143328897_p20776164115815">-</p> <td class="cellrowborder" valign="top" width="13.211321132113213%" headers="mcps1.3.3.1.9.1.8 "><p id="apig-api-20200402__en-us_topic_0000001143328897_p20776164115815">-</p>
</td> </td>
</tr> </tr>
<tr id="apig-api-20200402__en-us_topic_0000001143328897_row153455296504"><td class="cellrowborder" valign="top" width="13.671367136713672%" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20200402__en-us_topic_0000001143328897_p16184017514">sm_cipher_type</p>
</td>
<td class="cellrowborder" valign="top" width="10.551055105510551%" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20200402__en-us_topic_0000001143328897_p8182025118">Encrypting local sensitive data with commercial cryptographic algorithms</p>
</td>
<td class="cellrowborder" valign="top" width="10.99109910991099%" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20200402__en-us_topic_0000001143328897_p018180145110">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.901290129012901%" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20200402__en-us_topic_0000001143328897_p9973174425816">-</p>
</td>
<td class="cellrowborder" valign="top" width="12.241224122412241%" headers="mcps1.3.3.1.9.1.5 "><p id="apig-api-20200402__en-us_topic_0000001143328897_p109732044145819">-</p>
</td>
<td class="cellrowborder" valign="top" width="14.281428142814285%" headers="mcps1.3.3.1.9.1.6 "><p id="apig-api-20200402__en-us_topic_0000001143328897_p1597311441582">-</p>
</td>
<td class="cellrowborder" valign="top" width="12.151215121512152%" headers="mcps1.3.3.1.9.1.7 "><p id="apig-api-20200402__en-us_topic_0000001143328897_p59733449587">-</p>
</td>
<td class="cellrowborder" valign="top" width="13.211321132113213%" headers="mcps1.3.3.1.9.1.8 "><p id="apig-api-20200402__en-us_topic_0000001143328897_p129731544165820">-</p>
</td>
</tr>
<tr id="apig-api-20200402__en-us_topic_0000001143328897_row10178836505"><td class="cellrowborder" valign="top" width="13.671367136713672%" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20200402__en-us_topic_0000001143328897_p11189012510">rate_limit_algorithm</p> <tr id="apig-api-20200402__en-us_topic_0000001143328897_row10178836505"><td class="cellrowborder" valign="top" width="13.671367136713672%" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20200402__en-us_topic_0000001143328897_p11189012510">rate_limit_algorithm</p>
</td> </td>
<td class="cellrowborder" valign="top" width="10.551055105510551%" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20200402__en-us_topic_0000001143328897_p21816018513">Request throttling algorithm switchover</p> <td class="cellrowborder" valign="top" width="10.551055105510551%" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20200402__en-us_topic_0000001143328897_p21816018513">Request throttling algorithm switchover</p>

0
docs/apig/api-ref/en-us_image_0173593324.png → docs/apig/api-ref/en-us_image_0000002120194306.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 27 KiB

After

Width:  |  Height:  |  Size: 27 KiB

0
docs/apig/api-ref/en-us_image_0000001988900321.png → docs/apig/api-ref/en-us_image_0000002120347354.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 274 KiB

After

Width:  |  Height:  |  Size: 274 KiB

0
docs/apig/api-ref/en-us_image_0173593323.png → docs/apig/api-ref/en-us_image_0000002120352414.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 24 KiB

0
docs/apig/api-ref/en-us_image_0173593322.png → docs/apig/api-ref/en-us_image_0000002155592541.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 71 KiB

After

Width:  |  Height:  |  Size: 71 KiB

0
docs/apig/api-ref/en-us_image_0000001892790552.png → docs/apig/api-ref/en-us_image_0000002155592549.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 90 KiB

After

Width:  |  Height:  |  Size: 90 KiB

0
docs/apig/api-ref/en-us_image_0173593326.png → docs/apig/api-ref/en-us_image_0000002155714161.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 22 KiB