Construct a Request

• This section https://ctecs-xxx.ctapi.ctyun.cn/v4/region/customerResources https://ctecs-xxx.ctapi.ctyun.cn/v4/region/customerResources returns non-200

• This section https://ctecs-xxx.ctapi.ctyun.cn/v4/region/customerResources https://ctecs-xxx.ctapi.ctyun.cn/v4/region/customerResources returns non-200

• This section API Debugging https://eop.ctyun.cn/ebp/searchCtapi/ctapiDebugCenter returns non-200

Construct a Request

This section describes the structure of a REST API request, and uses "Querying User Resources Based on regionID" of ECS as an example to demonstrate how to call the API.

Sample Request

POST https://ctecs-xxx.ctapi.ctyun.cn/v4/region/customerResources?prodInstId=11&startTime=2021-04-04T06:01:46ZHTTP/1.1
Content-Type:application/json
ctyun-eop-request-id:0ffb9b07-d5a8-4e19-b3ce-12dfb9705a1d
Eop-Authorization:4a4bdc57e06542199b5f98d4cd107be2 Headers=ctyun-eop-request-id;eop-date Signature=b2WEo4nh9ewn6SWOP0ii5g8L0z9CT5gprpDWntlCX9I=
Eop-date:20221107T093029Z

The requested URI.

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

Example:

To query user resources based on regionID, obtain the endpoint "ctecs-xxx.ctapi.ctyun.cn" for this region and the resource-path (/v4/region/customerResources) in the URI of the API. Then, construct the URI as follows:

https://ctecs-xxx.ctapi.ctyun.cn/v4/region/customerResources

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

**{resource-path} ** Resource path. Example of an encoded standard URI:

Front:
/v4/region/customerResources api/code
Back:
/v4/region/customerResources%20api/code

Note:

Resource path {resource-path} is the section between the end of HTTP Host and the question mark (?) of the query string parameter (if any). The redundant and relative path parts need to be removed according to the RFC 3986 standardized URI path specifications. Each part of the path must be URI encoded.

**{query-string} ** Query parameter. Example of a standard query string:

Front:
prodInstId=11&startTime=2021-04-04T06:01:46Z
Back:
prodInstId=11&startTime=2021-04-04T06%3A01%3A46Z

Note:

{query-string} is a key-value pair that is spliced with an equal sign (=). The value must be URI encoded based on the RFC 3986 URL encoding specifications. not for the key. Use an empty string for parameters without a value.

Append an ampersand (&) to every parameter value, except for the last one in the list.

Use %XY to perform percent encoding on all other characters. X and Y indicate hexadecimal characters (0- 9 and A–F). For example, the space character must be encoded as %20 (instead of a + used in some encodings), and an extended UTF-8 character must be encoded in the "%XY%ZA%BC" format.

RFC 3986 requirements:

Characters A-Z, a-z, 0-9, and special characters including -, _, . are not encoded.

Encode all other ASCII code characters. The encoding format is % plus a hexadecimal ASCII code. For example, double quotes (") are encoded as %22. The space is encoded as %20, instead of a plus sign (+).

Non-ASCII code is encoded in UTF-8 format.

Request Methods

If the resource does not exist, a new resource may be created by PATCH.

In the URI section of "Query User Resources Based on RegionID", the request method is POST. The request is as follows:

POST https://ctecs-xxx.ctapi.ctyun.cn/v4/region/customerResources

Request Header

Eop-Authorization Signature authentication:

Step 1: Construct a string for signature (sigture)

sigture = combined list of ranked headers that need to be signed + "\n" + encoded query + "\n" + toHex(sha256 (original body)).

sigture example 1: (Predefinition: The query is empty, sorted headers to be signed are as follows: ctyun-eop-request-id:27cfe4dc-e640-45f6-92ca-492ca73e8680**\neop-date:20220525T160752Z\n**, and the sha256 digested body parameter in hexadecimal is e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855): ctyun-eop-request-id:27cfe4dc-e640-45f6-92ca-492ca73e8680**\neop-date:20220525T160752Z\n\n\n**e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855.

sigture example 2: (Predefinition: The query is not empty, sorted headers to be signed are as follows: ctyun-eop-request-id:27cfe4dc-e640-45f6-92ca-492ca73e8680**\neop-date:20220525T160752Z\n**, and the sha256 digested body parameter in hexadecimal is e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855): ctyun-eop-request-id:27cfe4dc-e640-45f6-92ca-492ca73e8680**\neop-date:20220525T160930Z\n\n**aa=1&bb=2**\n**e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855.

Step 2: Construct the dynamic key (kdate)

1. Use eop-date as the data and sk as the key to calculate ktime.

2. Use ak as the data and ktime as the key to calculate kAk.

3. Use the kAk as the key and the year, month, and day for the eop-date as the data to calculate kdate.

Step 3: Construct the signature

Use kdate as the key, sigture as the data, and encode the result in Base64 to get the signature.

Step 4: Construct Eop-Authorization

1. Construct headers.

2. Obtain Eop-Authorization.

Eop-Authorization:ak Headers=xxx Signature=xxx.

Reminder:

You can go to the API Debugging page to perform online debugging.