You can configure origin-pull rules for buckets in the COS console. If the object you request does not exist in the bucket, or a specific request needs to be redirected, you can configure origin-pull rules to access corresponding data via COS. Origin-pull configurations are mainly used for hot data migration, redirecting specific requests, and other relevant scenarios.
Note:
The success rate of data origin-pull depends on your network environment.
Origin-Pull Rules
Trigger condition
In async and sync origin-pull modes, origin-pull is triggered only when the request returns the 404 error.
In redirect mode, you can customize HTTP status codes between 400 and 599 to trigger origin-pull.
Origin access
In async and sync origin-pull modes, you can set whether to pass through the QueryString and header information of the COS access request to the origin, and configure to carry additional header information when requesting the origin. In redirect mode, you can only set whether to pass through the QueryString.
If GET range is specified during the GET operation, COS will send an async request without range in addition to the original request to get the complete object data and store it in COS.
Response and storage
The origin can return data in chunked encoding.
If the origin returns a 404 status code, it will be passed through to COS and returned to the user. If 3xx Following Policy is enabled, when the origin returns a 3xx status code, COS will pull data from another origin. If the origin returns other non-3XX status codes, COS will return a 424 status code.
The file returned by origin-pull will be stored in COS with the filename used when the origin is requested. For example, if the file example.jpg requested by a user does not exist in the bucket, COS will trigger the origin-pull mechanism to pull the file from the configured origin-pull address http://origin.com/example.jpg and rename the file stored in the bucket example.jpg.
The new object stored in COS will contain the following metadata, with the data content following the values in the origin:
3. Click the name of the bucket for which you want to set origin-pull.
4. Select Basic Configurations > Origin-Pull on the left, and click Add Rule.
5. In the pop-up window, configure the following information and click Next:
Origin-Pull Mode: Select an origin-pull mode as needed.
Async Origin-Pull: If the requested file doesn't exist in COS, COS will search for it on the specified origin. In the Async Origin-Pull mode, COS returns 302 to the client after finding that the file does not exist. The client jumps to the specified origin, and then asynchronously uploads the file to the COS bucket.
Note:
Async origin-pull does not directly return the file; instead, it returns a 302 status code to the client first and then asynchronously uploads the file to COS.
1. We recommend you enable Follow 302 to pull data from the origin.
2. The file upload time is subject to multiple factors, and no SLA can be promised. We recommend you select sync origin-pull if your business is sensitive to delays.
Sync Origin-Pull: If the requested file doesn't exist in COS, COS will search for it on the specified origin, return it to the client, and upload it to the bucket.
Redirect: If a specified error is reported when accessing the bucket, COS will return the redirection address to the client but will not save the file from the origin. The client can request the resource from the origin at the redirection address.
Origin-Pull Condition: Specify all conditions that must be met at the same time for triggering origin-pull.
HTTP Status Code 404: If you select Async Origin-Pull or Sync Origin-Pull, this parameter is required and cannot be canceled, and origin-pull will be triggered when the HTTP status code is 404. If you select Redirect, you can enter an HTTP status code ranging from 400 to 599.
File name prefix: When the requested file matches the prefix, the origin-pull rule will be triggered. For example, if you set this option to prefix, when you access https://examplebucket-1250000000.cos.ap-chengdu.myqcloud.com/prefix123.jpg and the returned HTTP status code is 404, the origin-pull rule will be triggered.
Origin-Pull Protocol: The protocol used by COS to access the specified origin. The options include Force HTTPS, Force HTTP, and Follow request protocol.
If you select Force HTTPS or Force HTTP, COS will access the origin using HTTPS or HTTP respectively.
If you select Follow request protocol, COS will access the origin with the protocol used in the request.
Request Parameter: Specify whether to pass through the queryString request parameters carried when accessing COS to the origin.
Passthrough specifies the request header: Specify the request headers you want to pass through to the origin. If you select Redirect as the origin-pull mode, do not set this parameter.
New request header: You can add additional request headers to be carried during origin-pull. If you select Redirect as the origin-pull mode, do not set this parameter.
6. Configure the following information based on the selected origin-pull mode and click Next:
Async origin-pull
Sync origin-pull
Redirect
Origin-Pull Address: Enter the domain name or IP address without the http:// or https:// prefix. You can also add the port number after the domain name or IP address.
Example of a correct address:
abc.example.com
abc.example.com:8080
202.96.128.86
202.96.128.86:8080
Standby forwarding address: You can enter a domain name or IP address as configured below:
Fixed file: Specifies a fixed file to which all requests are redirected when the origin-pull rule is triggered.
Specified prefix: Specifies the prefix for the file to which a request is redirected when the origin-pull rule is triggered. For example, if the prefix is specified as test, the request is redirected to <origin-pull address>/test/prefix123. jpg when you access https://examplebucket-1250000000.cos.ap-chengdu.myqcloud.com/prefix123.jpg, and the origin-pull rule is triggered.
Specified suffix: Specifies the suffix for the file to which a request is redirected when the origin-pull rule is triggered. For example, if the suffix is specified as .jpg, the request is redirected to <origin-pull address>/prefix123.jpg when you access https://examplebucket-1250000000.cos.ap-chengdu.myqcloud.com/prefix123, and the origin-pull rule is triggered.
Note
If you select Fixed file, the other fields cannot be used.
Specified prefix and Specified suffix can be used at the same time.
3xx Following Policy: If this policy is enabled, when your origin returns a 3xx redirect, COS will follow it to pull data from another origin.
Origin-Pull Address: Enter the domain name or IP address without the http:// or https:// prefix. You can also add the port number after the domain name or IP address.
Example of a correct address:
abc.example.com
abc.example.com:8080
202.96.128.86
202.96.128.86:8080
Standby forwarding address: You can enter a domain name or IP address as configured below:
Fixed file: Specifies a fixed file to which all requests are redirected when the origin-pull rule is triggered.
Specified prefix: Specifies the prefix for the file to which a request is redirected when the origin-pull rule is triggered. For example, if the prefix is specified as test, the request is redirected to <origin-pull address>/test/prefix123. jpg when you access https://examplebucket-1250000000.cos.ap-chengdu.myqcloud.com/prefix123.jpg, and the origin-pull rule is triggered.
Specified suffix: Specifies the suffix for the file to which a request is redirected when the origin-pull rule is triggered. For example, if the suffix is specified as .jpg, the request is redirected to <origin-pull address>/prefix123.jpg when you access https://examplebucket-1250000000.cos.ap-chengdu.myqcloud.com/prefix123, and the origin-pull rule is triggered.
Note
If you select Fixed file, the other fields cannot be used.
Specified prefix and Specified suffix can be used at the same time.
3xx Following Policy: If this policy is enabled, when your origin returns a 3xx redirect, COS will follow it to pull data from another origin.
Packet of origin site: After this feature is enabled, the packet from the origin will be directly returned, including the status code and other information.
Origin-Pull Address: Enter the domain name or IP address without the http:// or https:// prefix. You can also add the port number after the domain name or IP address.
Example of a correct address:
abc.example.com
abc.example.com:8080
202.96.128.86
202.96.128.86:8080
Standby forwarding address: You can enter a domain name or IP address as configured below:
Fixed file: Specifies a fixed file to which all requests are redirected when the origin-pull rule is triggered.
Specified prefix: Specifies the prefix for the file to which a request is redirected when the origin-pull rule is triggered. For example, if the prefix is specified as test, the request is redirected to <origin-pull address>/test/prefix123. jpg when you access https://examplebucket-1250000000.cos.ap-chengdu.myqcloud.com/prefix123.jpg, and the origin-pull rule is triggered.
Specified suffix: Specifies the suffix for the file to which a request is redirected when the origin-pull rule is triggered. For example, if the suffix is specified as .jpg, the request is redirected to <origin-pull address>/prefix123.jpg when you access https://examplebucket-1250000000.cos.ap-chengdu.myqcloud.com/prefix123, and the origin-pull rule is triggered.
Note
If you select Fixed file, the other fields cannot be used.
Specified prefix and Specified suffix can be used at the same time.
Redirect Code: You can select 301 (default value), 302, or 307.
7. Confirm that the configured origin-pull rule is correct and click OK.
By default, COS always gives the highest priority to the most recent rule, by which it performs origin-pull. To change the priority manually, you can click the "Edit" icon under the "Priority" column in the rule list.
Examples
Background
A user whose APPID is 1250000000 created a bucket named "examplebucket-1250000000", and enabled CDN acceleration endpoint domain name:
examplebucket-1250000000.file.myqcloud.com
Configure the origin-pull address of the bucket to be:
abc.example.com
Store the image picture.jpg on the origin http://abc.example.com.
First access by client (without sync origin-pull enabled):
When COS finds that the object cannot be hit, it returns the HTTP status code 200 to the client and redirects to the following address:
http://abc.example.com/picture.jpg
The origin then provides the object to the client to ensure access, and COS copies picture.jpg from the origin and saves it to the root directory of the bucket "example".
Yes
No
Was this page helpful?