From 3fa966049f3d5a90dbcda461d88d76213cf52c83 Mon Sep 17 00:00:00 2001 From: "Zheng, Xiu" Date: Mon, 22 Jul 2024 17:01:37 +0000 Subject: [PATCH] css api 20240704 version Reviewed-by: Kacur, Michal Co-authored-by: Zheng, Xiu Co-committed-by: Zheng, Xiu --- docs/css/api-ref/ALL_META.TXT.json | 24 +++-- docs/css/api-ref/AddIndependentNode.html | 2 +- docs/css/api-ref/CLASS.TXT.json | 8 +- docs/css/api-ref/ListImages.html | 2 +- docs/css/api-ref/ResetPassword.html | 2 +- docs/css/api-ref/RetryUpgradeTask.html | 2 +- docs/css/api-ref/UpgradeCore.html | 2 +- docs/css/api-ref/UpgradeDetail.html | 2 +- docs/css/api-ref/css_03_0019.html | 14 +-- docs/css/api-ref/css_03_0024.html | 4 +- docs/css/api-ref/css_03_0062.html | 2 +- docs/css/api-ref/css_03_0065.html | 6 +- docs/css/api-ref/css_03_0081.html | 2 +- docs/css/api-ref/css_03_0134.html | 2 +- docs/css/api-ref/css_03_0137.html | 15 +++ .../{iam_02_0008.html => css_03_0138.html} | 100 +++++++++--------- .../{iam_02_0510.html => css_03_0139.html} | 20 ++-- .../{iam_02_0511.html => css_03_0140.html} | 28 ++--- docs/css/api-ref/iam_01_0023.html | 15 --- 19 files changed, 128 insertions(+), 124 deletions(-) create mode 100644 docs/css/api-ref/css_03_0137.html rename docs/css/api-ref/{iam_02_0008.html => css_03_0138.html} (54%) rename docs/css/api-ref/{iam_02_0510.html => css_03_0139.html} (63%) rename docs/css/api-ref/{iam_02_0511.html => css_03_0140.html} (62%) delete mode 100644 docs/css/api-ref/iam_01_0023.html diff --git a/docs/css/api-ref/ALL_META.TXT.json b/docs/css/api-ref/ALL_META.TXT.json index 9e4d6705..bc8dfba7 100644 --- a/docs/css/api-ref/ALL_META.TXT.json +++ b/docs/css/api-ref/ALL_META.TXT.json @@ -78,7 +78,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Supported Cluster Versions", @@ -106,8 +108,8 @@ "githuburl":"" }, { - "uri":"iam_01_0023.html", - "node_id":"iam_01_0023.xml", + "uri":"css_03_0137.html", + "node_id":"css_03_0137.xml", "product_code":"css", "code":"6", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -127,8 +129,8 @@ "githuburl":"" }, { - "uri":"iam_02_0008.html", - "node_id":"iam_02_0008.xml", + "uri":"css_03_0138.html", + "node_id":"css_03_0138.xml", "product_code":"css", "code":"7", "des":"This section describes the structure of a RESTful API request, and uses the API for Obtaining a User Token as an example to describe how to call an API. A token is a user", @@ -148,8 +150,8 @@ "githuburl":"" }, { - "uri":"iam_02_0510.html", - "node_id":"iam_02_0510.xml", + "uri":"css_03_0139.html", + "node_id":"css_03_0139.xml", "product_code":"css", "code":"8", "des":"CSS supports token authentication.The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API.A ", @@ -169,8 +171,8 @@ "githuburl":"" }, { - "uri":"iam_02_0511.html", - "node_id":"iam_02_0511.xml", + "uri":"css_03_0140.html", + "node_id":"css_03_0140.xml", "product_code":"css", "code":"9", "des":"After sending a request, you will receive a response containing the status code, response header, and response body.A status code is a group of digits, ranging from 1xx t", @@ -1357,7 +1359,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Modifying Basic Configurations of a Cluster Snapshot", diff --git a/docs/css/api-ref/AddIndependentNode.html b/docs/css/api-ref/AddIndependentNode.html index 7d78ee4f..488a4cdf 100644 --- a/docs/css/api-ref/AddIndependentNode.html +++ b/docs/css/api-ref/AddIndependentNode.html @@ -3,7 +3,7 @@

Adding Master and Client Nodes

Function

This API is used to add master and client nodes to a cluster.

-

Calling Method

For details, see Calling APIs.

+

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/type/{type}/independent

diff --git a/docs/css/api-ref/CLASS.TXT.json b/docs/css/api-ref/CLASS.TXT.json index 80b2c5f4..0f9d7874 100644 --- a/docs/css/api-ref/CLASS.TXT.json +++ b/docs/css/api-ref/CLASS.TXT.json @@ -48,7 +48,7 @@ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"css", "title":"Calling APIs", - "uri":"iam_01_0023.html", + "uri":"css_03_0137.html", "doc_type":"api", "p_code":"", "code":"6" @@ -57,7 +57,7 @@ "desc":"This section describes the structure of a RESTful API request, and uses the API for Obtaining a User Token as an example to describe how to call an API. A token is a user", "product_code":"css", "title":"Making an API Request", - "uri":"iam_02_0008.html", + "uri":"css_03_0138.html", "doc_type":"api", "p_code":"6", "code":"7" @@ -66,7 +66,7 @@ "desc":"CSS supports token authentication.The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API.A ", "product_code":"css", "title":"Authentication", - "uri":"iam_02_0510.html", + "uri":"css_03_0139.html", "doc_type":"api", "p_code":"6", "code":"8" @@ -75,7 +75,7 @@ "desc":"After sending a request, you will receive a response containing the status code, response header, and response body.A status code is a group of digits, ranging from 1xx t", "product_code":"css", "title":"Returned Values", - "uri":"iam_02_0511.html", + "uri":"css_03_0140.html", "doc_type":"api", "p_code":"6", "code":"9" diff --git a/docs/css/api-ref/ListImages.html b/docs/css/api-ref/ListImages.html index aa89ed0a..c83a0e24 100644 --- a/docs/css/api-ref/ListImages.html +++ b/docs/css/api-ref/ListImages.html @@ -3,7 +3,7 @@

Obtaining a Target Image ID

Function

This API is used to obtain the ID of an image that can be upgraded in the current cluster.

-

Calling Method

For details, see Calling APIs.

+

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/target/{upgrade_type}/images

diff --git a/docs/css/api-ref/ResetPassword.html b/docs/css/api-ref/ResetPassword.html index 1d617476..9673e1f9 100644 --- a/docs/css/api-ref/ResetPassword.html +++ b/docs/css/api-ref/ResetPassword.html @@ -3,7 +3,7 @@

Changing a Password

Function

This API is used to change the password of a cluster.

-

Calling Method

For details, see Calling APIs.

+

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/password/reset

diff --git a/docs/css/api-ref/RetryUpgradeTask.html b/docs/css/api-ref/RetryUpgradeTask.html index 69e10e12..f3d78a01 100644 --- a/docs/css/api-ref/RetryUpgradeTask.html +++ b/docs/css/api-ref/RetryUpgradeTask.html @@ -3,7 +3,7 @@

Retrying a Failed Upgrade Task

Function

The upgrade takes a long time and the upgrade may fail due to network problems. You can use this API to retry a task or terminate the impact of a task.

-

Calling Method

For details, see Calling APIs.

+

Calling Method

For details, see Calling APIs.

URI

PUT /v1.0/{project_id}/clusters/{cluster_id}/upgrade/{action_id}/retry

diff --git a/docs/css/api-ref/UpgradeCore.html b/docs/css/api-ref/UpgradeCore.html index 76ba3f5d..f7f1cb29 100644 --- a/docs/css/api-ref/UpgradeCore.html +++ b/docs/css/api-ref/UpgradeCore.html @@ -3,7 +3,7 @@

Upgrading a Cluster Kernel

Function

This API is used to upgrade Elasticsearch from an earlier version to a later version or the same version.

-

Calling Method

For details, see Calling APIs.

+

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/inst-type/{inst_type}/image/upgrade

diff --git a/docs/css/api-ref/UpgradeDetail.html b/docs/css/api-ref/UpgradeDetail.html index 424fc075..5efbac5c 100644 --- a/docs/css/api-ref/UpgradeDetail.html +++ b/docs/css/api-ref/UpgradeDetail.html @@ -3,7 +3,7 @@

Obtaining Upgrade Details

Function

The upgrade takes a long time. You can call this API to check the upgrade progress on a node.

-

Calling Method

For details, see Calling APIs.

+

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/upgrade/detail

diff --git a/docs/css/api-ref/css_03_0019.html b/docs/css/api-ref/css_03_0019.html index e61dde23..1c8966d2 100644 --- a/docs/css/api-ref/css_03_0019.html +++ b/docs/css/api-ref/css_03_0019.html @@ -21,7 +21,7 @@

String

-

Project ID. For details, see Obtaining a Project ID and Name.

+

Project ID. For details about how to obtain a project ID, see Obtaining a Project ID and Name.

@@ -179,7 +179,7 @@
-
Table 4 instance field description

Parameter

+
@@ -233,7 +233,7 @@
Table 4 instance field description

Parameter

Mandatory

-
Table 5 volume field description

Parameter

+
@@ -268,7 +268,7 @@
Table 5 volume field description

Parameter

Mandatory

-
Table 6 nics field description

Parameter

+
@@ -309,7 +309,7 @@
Table 6 nics field description

Parameter

Mandatory

-
Table 7 datastore field description

Parameter

+
@@ -334,7 +334,7 @@ - @@ -498,7 +498,7 @@
Table 7 datastore field description

Parameter

Mandatory

String

Cluster type. The default value is Elasticsearch. Currently, the value can only be Elasticsearch.

+

Engine type. Elasticsearch and OpenSearch are supported.
-
Table 12 cluster field description

Parameter

+
diff --git a/docs/css/api-ref/css_03_0024.html b/docs/css/api-ref/css_03_0024.html index efb6f123..b592998e 100644 --- a/docs/css/api-ref/css_03_0024.html +++ b/docs/css/api-ref/css_03_0024.html @@ -60,12 +60,12 @@ - - diff --git a/docs/css/api-ref/css_03_0062.html b/docs/css/api-ref/css_03_0062.html index 3c43af77..37bb7222 100644 --- a/docs/css/api-ref/css_03_0062.html +++ b/docs/css/api-ref/css_03_0062.html @@ -8,7 +8,7 @@

Involved APIs

If you use a token for authentication, you must obtain the token and add X-Auth-Token to the request header of the API when making an API call.

  • API for obtaining tokens from IAM
  • API for creating CSS clusters
-

Procedure

  1. Obtain the token. Send POST https://IAM endpoint/v3/auth/tokens.

    Obtain the token by following instructions in Authentication.

    +

    Procedure

    1. Obtain the token. Send POST https://IAM endpoint/v3/auth/tokens.

      Obtain the token by following instructions in Authentication.

      The value of X-Subject-Token in the response header is the user token.

    2. Add Content-type and X-Auth-Token to the request header.
      • Content-Type: specifies the request body type or format. Its default value is application/json.
      • X-Auth-Token: Enter the user token obtained in 1.
    3. Send a cluster creation request and specify the following parameters in the request body:
      POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters
diff --git a/docs/css/api-ref/css_03_0065.html b/docs/css/api-ref/css_03_0065.html
index fbde0063..2ea37cd7 100644
--- a/docs/css/api-ref/css_03_0065.html
+++ b/docs/css/api-ref/css_03_0065.html
@@ -16,13 +16,13 @@
diff --git a/docs/css/api-ref/css_03_0081.html b/docs/css/api-ref/css_03_0081.html index 7d49b490..c9b94838 100644 --- a/docs/css/api-ref/css_03_0081.html +++ b/docs/css/api-ref/css_03_0081.html @@ -57,7 +57,7 @@ - diff --git a/docs/css/api-ref/css_03_0134.html b/docs/css/api-ref/css_03_0134.html index ad6ef1e0..d23e15b8 100644 --- a/docs/css/api-ref/css_03_0134.html +++ b/docs/css/api-ref/css_03_0134.html @@ -133,7 +133,7 @@
Table 12 cluster field description

Parameter

Type

2022-07-28

  • Combined "Common Request Parameters" and "Common Response Parameters" into Calling APIs.
  • Added cluster version 7.10.2.
+
  • Combined "Common Request Parameters" and "Common Response Parameters" into Calling APIs.
  • Added cluster version 7.10.2.

2022-06-30

API

Action

-

+

IAM Project

-

(Project)

+

Enterprise Project

-

(Enterprise Project)

+

No

Array of tag objects

+

Array of tag objects

Tag list

Integer

Task execution status.

-
  • 150: The task is not executed.
  • 200: The task has been executed.
  • 300: The task has been sent.
+
  • 150: Disabled
  • 200: Enabled
  • 300: Sent

summary

diff --git a/docs/css/api-ref/css_03_0137.html b/docs/css/api-ref/css_03_0137.html new file mode 100644 index 00000000..3c02759c --- /dev/null +++ b/docs/css/api-ref/css_03_0137.html @@ -0,0 +1,15 @@ + + +

Calling APIs

+
+ + diff --git a/docs/css/api-ref/iam_02_0008.html b/docs/css/api-ref/css_03_0138.html similarity index 54% rename from docs/css/api-ref/iam_02_0008.html rename to docs/css/api-ref/css_03_0138.html index 42918f0a..fcda3965 100644 --- a/docs/css/api-ref/iam_02_0008.html +++ b/docs/css/api-ref/css_03_0138.html @@ -1,97 +1,97 @@ - +

Making an API Request

-

This section describes the structure of a RESTful API request, and uses the API for Obtaining a User Token as an example to describe how to call an API. A token is a user's access credential, which contains the user identity and permission information. The obtained token is used to authenticate the calling of other APIs.

-

Request URI

A request URI is in the following format:

-

{URI-scheme}://{Endpoint}/{resource-path}?{query-string}

+

This section describes the structure of a RESTful API request, and uses the API for Obtaining a User Token as an example to describe how to call an API. A token is a user's access credential, which contains the user identity and permission information. The obtained token is used to authenticate the calling of other APIs.

+

Request URI

A request URI is in the following format:

+

{URI-scheme}://{Endpoint}/{resource-path}?{query-string}

-
Table 1 Request URL

Parameter

+
- - - - - - - - -
Table 1 Request URL

Parameter

Description

+

Description

URI-scheme

+

URI-scheme

Protocol used to transmit requests. All APIs use HTTPS.

+

Protocol used to transmit requests. All APIs use HTTPS.

Endpoint

+

Endpoint

Domain name or IP address of the server running the REST service. The endpoint varies between services in different regions. It can be obtained from Endpoints.

+

Domain name or IP address of the server running the REST service. The endpoint varies between services in different regions. It can be obtained from Endpoints.

resource-path

+

resource-path

API access path for performing a specified operation. Obtain the value from the URI of the API. For example, the resource-path of the API for obtaining a user token is /v3/auth/tokens.

+

API access path for performing a specified operation. Obtain the value from the URI of the API. For example, the resource-path of the API for obtaining a user token is /v3/auth/tokens.

query-string

+

query-string

Query parameter, which is optional. Ensure that a question mark (?) is included before a query parameter that is in the format of "Parameter name=Parameter value". For example, limit=10 indicates that a maximum of 10 pieces of data is to be viewed.

+

Query parameter, which is optional. Ensure that a question mark (?) is included before a query parameter that is in the format of "Parameter name=Parameter value". For example, limit=10 indicates that a maximum of 10 pieces of data is to be viewed.
-

-
For example, to obtain an IAM token in a region, obtain the endpoint of IAM for this region and the resource-path (/v3/auth/tokens) in the URI of the API used to obtain a user token. Then, construct the URI as follows:
https://<iam-endpoint>/v3/auth/tokens

+

+
For example, to obtain an IAM token in a region, obtain the endpoint of IAM for this region and the resource-path (/v3/auth/tokens) in the URI of the API used to obtain a user token. Then, construct the URI as follows:
https://<iam-endpoint>/v3/auth/tokens

 

-
 
To simplify the URI display, each API is provided with only a resource-path and a request method. This is because the URI-scheme value of all APIs is HTTPS, and the endpoints in a region are the same. Therefore, the two parts are omitted.

+
 
To simplify the URI display, each API is provided with only a resource-path and a request method. This is because the URI-scheme value of all APIs is HTTPS, and the endpoints in a region are the same. Therefore, the two parts are omitted.

 

 

-
Request Methods
HTTP-based request methods, which are also called operations or actions, specify the type of operations that you are requesting.

-
  • GET: requests the server to return specified resources.
  • PUT: requests the server to update specified resources.
  • POST: requests the server to add resources or perform special operations.
  • DELETE: requests the server to delete specified resources, for example, an object.
  • HEAD: requests a server resource header.
  • PATCH: requests the server to update partial content of a specified resource. If the target resource does not exist, PATCH may create a resource.

-
If POST is displayed in the URI of the API for obtaining a user token, the request is as follows:

-
-POST https://{iam-endpoint}/v3/auth/tokens

+
Request Methods
HTTP-based request methods, which are also called operations or actions, specify the type of operations that you are requesting.

+
  • GET: requests the server to return specified resources.
  • PUT: requests the server to update specified resources.
  • POST: requests the server to add resources or perform special operations.
  • DELETE: requests the server to delete specified resources, for example, an object.
  • HEAD: requests a server resource header.
  • PATCH: requests the server to update partial content of a specified resource. If the target resource does not exist, PATCH may create a resource.

+
If POST is displayed in the URI of the API for obtaining a user token, the request is as follows:

+
+POST https://{iam-endpoint}/v3/auth/tokens

 

-
Request Header
You can also add additional fields to a request, such as the fields required by a specified URI or an HTTP method. For example, to request for the authentication information, add Content-Type, which specifies the request body type.

-
Table 2 lists common request header fields.

+
Request Header
You can also add additional fields to a request, such as the fields required by a specified URI or an HTTP method. For example, to request for the authentication information, add Content-Type, which specifies the request body type.

+
Table 2 lists common request header fields.

 
-
Table 2 Common request headers
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
Table 2 Common request headers
Parameter

 
Mandatory

+
Mandatory

 
Description

+
Description

 		
 

 
Content-Type

+
Content-Type

 
Yes

+
Yes

 
Message body type (or format). You are advised to use the default value application/json.

+
Message body type (or format). You are advised to use the default value application/json.

 		
 
X-Auth-Token

+
X-Auth-Token

 
No (Mandatory for token-based authentication)

+
No (Mandatory for token-based authentication)

 
User token.

-
Response for calling the "Obtaining a User Token" API. This API is the only one that does not require authentication. After the request is processed, the value of X-Subject-Token in the response header (Header) is the token value.

+
User token.

+
Response for calling the "Obtaining a User Token" API. This API is the only one that does not require authentication. After the request is processed, the value of X-Subject-Token in the response header (Header) is the token value.

 		
 
X-Language

+
X-Language

 
No

+
No

 
Request language

+
Request language

 		
 

 
 

 

-
The API used to obtain a user token does not require authentication. Therefore, only the Content-Type field needs to be added to requests for calling the API. An example of such requests is as follows:

-
POST https://{iam-endpoint}/v3/auth/tokens
+
The API used to obtain a user token does not require authentication. Therefore, only the Content-Type field needs to be added to requests for calling the API. An example of such requests is as follows:

+
POST https://{iam-endpoint}/v3/auth/tokens
 Content-Type: application/json

 
-
Request Body
A request body conveys information other than the request header and is generally sent in a structured format defined by the request header field Content-Type. 

-
The request body varies according to the APIs. Certain APIs do not require the request body, such as the GET and DELETE APIs.

-
In the case of the API used to obtain a user token, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace username, domainname, ******** (login password), and xxxxxxxxxxxxxxxxxx (project ID) with the actual values. To learn how to obtain a project ID, see Obtaining a Project ID and Name.

-
 
The scope parameter defines the application scope of the token, indicating that the obtained token can access only the resources in the specified project.

+
Request Body
A request body conveys information other than the request header and is generally sent in a structured format defined by the request header field Content-Type. 

+
The request body varies according to the APIs. Certain APIs do not require the request body, such as the GET and DELETE APIs.

+
In the case of the API used to obtain a user token, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace username, domainname, ******** (login password), and xxxxxxxxxxxxxxxxxx (project ID) with the actual values. To learn how to obtain a project ID, see Obtaining a Project ID and Name.

+
 
The scope parameter defines the application scope of the token, indicating that the obtained token can access only the resources in the specified project.

 

-
POST https://{iam-endpoint}/v3/auth/tokens
+
POST https://{iam-endpoint}/v3/auth/tokens
 Content-Type: application/json
 {
     "auth": {
@@ -101,27 +101,27 @@ Content-Type: application/json
             ],
             "password": {
                 "user": {
-                    "name": "username",    //Username
-                    "password": "********",    //Login password
+                    "name": "username",    //Username
+                    "password": "********",    //Login password
                     "domain": {
-                        "name": "domainname "    //Name of the account to which the user belongs
+                        "name": "domainname "    //Name of the account to which the user belongs
                     }
                 }
             }
         },
         "scope": {
             "project": {
-                "id": "xxxxxxxxxxxxxxxxxx"    //Project ID
+                "id": "xxxxxxxxxxxxxxxxxx"    //Project ID
             }
         }
     }
 }

-
If all data required by a request is available, you can send the request to call an API through curl, Postman, or coding. For the API of obtaining a user token, x-subject-token in the response header is the desired user token. Then, you can use the token to authenticate the calling of other APIs.

+
If all data required by a request is available, you can send the request to call an API through curl, Postman, or coding. For the API of obtaining a user token, x-subject-token in the response header is the desired user token. Then, you can use the token to authenticate the calling of other APIs.

 

 

 

 

-
Parent topic: Calling APIs

+
Parent topic: Calling APIs

 

 

 
diff --git a/docs/css/api-ref/iam_02_0510.html b/docs/css/api-ref/css_03_0139.html
similarity index 63%
rename from docs/css/api-ref/iam_02_0510.html
rename to docs/css/api-ref/css_03_0139.html
index d0ba91b4..0b573091 100644
--- a/docs/css/api-ref/iam_02_0510.html
+++ b/docs/css/api-ref/css_03_0139.html
@@ -1,12 +1,12 @@
-
+
 
 
Authentication

-
CSS supports token authentication.

-
Authentication Using Tokens
 
The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API.

+
CSS supports token authentication.

+
Authentication Using Tokens
 
The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API.

 

-
A token specifies certain permissions in a computer system. Authentication using a token adds the token to a request as its header during API calling to obtain permissions to operate APIs through IAM.

-
The API for obtaining a token is POST https://{IAM endpoint}/v3/auth/tokens. For details about how to obtain IAM endpoints, see Endpoints.

-
{
+
A token specifies certain permissions in a computer system. Authentication using a token adds the token to a request as its header during API calling to obtain permissions to operate APIs through IAM.

+
The API for obtaining a token is POST https://{IAM endpoint}/v3/auth/tokens. For details about how to obtain IAM endpoints, see Endpoints.

+
{
 	"auth": {
 		"identity": {
 			"methods": [
@@ -29,15 +29,15 @@
 		}
 	}
 }

-
After a token is obtained, the X-Auth-Token header field must be added to requests to specify the token when calling other APIs. For example, if the token is ABCDEFJ...., X-Auth-Token: ABCDEFJ.... can be added to a request as follows:

-
POST https://{endpoint}/v3/auth/projects
+
After a token is obtained, the X-Auth-Token header field must be added to requests to specify the token when calling other APIs. For example, if the token is ABCDEFJ...., X-Auth-Token: ABCDEFJ.... can be added to a request as follows:

+
POST https://{endpoint}/v3/auth/projects
 Content-Type: application/json
-X-Auth-Token: ABCDEFJ....

+X-Auth-Token: ABCDEFJ....

 

 

 

 

-
Parent topic: Calling APIs

+
Parent topic: Calling APIs

 

 

 
diff --git a/docs/css/api-ref/iam_02_0511.html b/docs/css/api-ref/css_03_0140.html
similarity index 62%
rename from docs/css/api-ref/iam_02_0511.html
rename to docs/css/api-ref/css_03_0140.html
index 1926aa20..880d0bd8 100644
--- a/docs/css/api-ref/iam_02_0511.html
+++ b/docs/css/api-ref/css_03_0140.html
@@ -1,17 +1,17 @@
-
+
 
 
Returned Values

-
Status Code
After sending a request, you will receive a response containing the status code, response header, and response body.

-
A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see Status Code.

-
If status code 201 is returned for the calling of the API for obtaining a user token, the request is successful.

+
Status Code
After sending a request, you will receive a response containing the status code, response header, and response body.

+
A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see Status Code.

+
If status code 201 is returned for the calling of the API for obtaining a user token, the request is successful.

 

-
Response Header
A response header corresponds to a request header, for example, Content-Type.

-
Figure 1 shows the response header for the API of obtaining a user token, where x-subject-token is the desired user token. Then, you can use the token to authenticate the calling of other APIs.

-
Figure 1 Header of the response to the request for obtaining a user token

+
Response Header
A response header corresponds to a request header, for example, Content-Type.

+
Figure 1 shows the response header for the API of obtaining a user token, where x-subject-token is the desired user token. Then, you can use the token to authenticate the calling of other APIs.

+
Figure 1 Header of the response to the request for obtaining a user token

 

-
Response Body
A response body is generally returned in a structured format, corresponding to the Content-Type in the response header, and is used to transfer content other than the response header.

-
The following shows part of the response body for the API of obtaining a user token.

-
{
+
Response Body
A response body is generally returned in a structured format, corresponding to the Content-Type in the response header, and is used to transfer content other than the response header.

+
The following shows part of the response body for the API of obtaining a user token.

+
{
     "token": {
         "expires_at": "2019-02-13T06:52:13.855000Z",
         "methods": [
@@ -23,17 +23,17 @@
                     {
                         "region_id": "xxx",
 ......

-
If an error occurs during API calling, the system returns an error code and a message to you. The following shows the format of an error response body:

-
{
+
If an error occurs during API calling, the system returns an error code and a message to you. The following shows the format of an error response body:

+
{
     "error_msg": "The format of message is error",
     "error_code": "AS.0001"
 }

-
In the preceding information, error_code is an error code, and error_msg describes the error.

+
In the preceding information, error_code is an error code, and error_msg describes the error.

 

 

 

 

-
Parent topic: Calling APIs

+
Parent topic: Calling APIs

 

 

 
diff --git a/docs/css/api-ref/iam_01_0023.html b/docs/css/api-ref/iam_01_0023.html
deleted file mode 100644
index 40992d7b..00000000
--- a/docs/css/api-ref/iam_01_0023.html
+++ /dev/null
@@ -1,15 +0,0 @@
-
-
-
Calling APIs

-

-
-