tencent cloud

Cloud Object Storage

Release Notes and Announcements
Release Notes
Announcements
Product Introduction
Overview
Features
Use Cases
Strengths
Concepts
Regions and Access Endpoints
Specifications and Limits
Service Regions and Service Providers
Billing
Billing Overview
Billing Method
Billable Items
Free Tier
Billing Examples
Viewing and Downloading Bill
Payment Overdue
FAQs
Getting Started
Console
Getting Started with COSBrowser
User Guide
Creating Request
Bucket
Object
Data Management
Batch Operation
Global Acceleration
Monitoring and Alarms
Operations Center
Data Processing
Content Moderation
Smart Toolbox
Data Processing Workflow
Application Integration
User Tools
Tool Overview
Installation and Configuration of Environment
COSBrowser
COSCLI (Beta)
COSCMD
COS Migration
FTP Server
Hadoop
COSDistCp
HDFS TO COS
GooseFS-Lite
Online Tools
Diagnostic Tool
Use Cases
Overview
Access Control and Permission Management
Performance Optimization
Accessing COS with AWS S3 SDK
Data Disaster Recovery and Backup
Domain Name Management Practice
Image Processing
Audio/Video Practices
Workflow
Direct Data Upload
Content Moderation
Data Security
Data Verification
Big Data Practice
COS Cost Optimization Solutions
Using COS in the Third-party Applications
Migration Guide
Migrating Local Data to COS
Migrating Data from Third-Party Cloud Storage Service to COS
Migrating Data from URL to COS
Migrating Data Within COS
Migrating Data Between HDFS and COS
Data Lake Storage
Cloud Native Datalake Storage
Metadata Accelerator
GooseFS
Data Processing
Data Processing Overview
Image Processing
Media Processing
Content Moderation
File Processing Service
File Preview
Troubleshooting
Obtaining RequestId
Slow Upload over Public Network
403 Error for COS Access
Resource Access Error
POST Object Common Exceptions
API Documentation
Introduction
Common Request Headers
Common Response Headers
Error Codes
Request Signature
Action List
Service APIs
Bucket APIs
Object APIs
Batch Operation APIs
Data Processing APIs
Job and Workflow
Content Moderation APIs
Cloud Antivirus API
SDK Documentation
SDK Overview
Preparations
Android SDK
C SDK
C++ SDK
.NET(C#) SDK
Flutter SDK
Go SDK
iOS SDK
Java SDK
JavaScript SDK
Node.js SDK
PHP SDK
Python SDK
React Native SDK
Mini Program SDK
Error Codes
Harmony SDK
Endpoint SDK Quality Optimization
Security and Compliance
Data Disaster Recovery
Data Security
Cloud Access Management
FAQs
Popular Questions
General
Billing
Domain Name Compliance Issues
Bucket Configuration
Domain Names and CDN
Object Operations
Logging and Monitoring
Permission Management
Data Processing
Data Security
Pre-signed URL Issues
SDKs
Tools
APIs
Agreements
Service Level Agreement
Privacy Policy
Data Processing And Security Agreement
Contact Us
Glossary

Custom Domain

PDF
Mode fokus
Ukuran font
Terakhir diperbarui: 2024-02-04 17:20:25

Overview

This document provides an overview of APIs and SDK code samples related to custom endpoints.
API
Operation
Description
PUT Bucket domain
Setting a custom endpoint
Sets a custom endpoint for a bucket
GET Bucket domain
Querying a custom endpoint
Queries the custom endpoint of a bucket
DELETE Bucket domain
Deleting a custom endpoint
Deletes the custom endpoint from a bucket

Setting a Custom Endpoint

API description

This API is used to bind a custom endpoint to an existing bucket.

Sample request

cos.putBucketDomain({
Bucket: 'examplebucket-1250000000', /* Required */
Region: 'ap-beijing', /* Required */
DomainRule: [{
Status: "DISABLED",
Name: "www.example.com",
Type: "REST"
},
{
Status: "DISABLED",
Name: "www.example.net",
Type: "WEBSITE",
}]
}, function(err, data) {
console.log(err || data);
});

Parameter description

Parameter Name
Description
Type
Required
Bucket
Name of the bucket for which to set a custom endpoint in the format: BucketName-APPID
String
Yes
Region
Bucket region. For the enumerated values, see Regions and Access Endpoints.
String
Yes
DomainRule
Custom endpoint configuration
Object
Yes
- Status
Status of the endpoint. Enumerated values: ENABLED, DISABLED
String
Yes
- Name
Name of the custom endpoint
String
Yes
- Type
Type of the origin server to bind. Enumerated values: REST, WEBSITE
String
Yes
- ForcedReplacement
Replaces an existing configuration. Enumerated values: CNAME, TXT. If this parameter is configured, validation will be forced on the ownership of the endpoint before the configuration is delivered.
String
No

Callback function description

function(err, data) { ... }
Parameter Name
Description
Type
err
Returns a network or service error when the request fails. If the request is successful, this is empty. For more information, see Error Codes.
Object
- statusCode
Returns an HTTP status code, such as 200, 403, and 404
Number
- headers
Returns headers
Object
data
Returns data when the request is successful. If the request fails, this is empty
Object
- statusCode
Returns an HTTP status code, such as 200, 403, and 404
Number
- headers
Returns headers
Object

Querying a Custom Endpoint

API description

This API is used to query the custom endpoint associated with a bucket.

Sample request

cos.getBucketDomain({
Bucket: 'examplebucket-1250000000', /* Required */
Region: 'ap-beijing', /* Required */
}, function(err, data) {
console.log(err || data);
});

Sample response

{
"DomainRule": [{
"Status": "DISABLED",
"Name": "www.example.com",
"Type": "REST"
}, {
"Status": "DISABLED",
"Name": "www.example.net",
"Type": "WEBSITE"
}],
"statusCode": 200,
"headers": {}
}

Parameter description

Parameter Name
Description
Type
Required
Bucket
Name of the bucket for which to query the custom endpoint in the format: BucketName-APPID
String
Yes
Region
Bucket region. For the enumerated values, see Regions and Access Endpoints
String
Yes

Callback function description

function(err, data) { ... }
Parameter Name
Description
Type
err
Returns a network or service error when the request fails. If the request is successful, this is empty. For more information, see Error Codes.
Object
- statusCode
Returns an HTTP status code, such as 200, 403, and 404
Number
- headers
Returns headers
Object
data
Returns data when the request is successful. If the request fails, this is empty
Object
- statusCode
Returns an HTTP status code, such as 200, 403, and 404
Number
- headers
Returns headers
Object
- DomainRule
Custom endpoint configuration
Object
- - Status
Status of the endpoint. Enumerated values: ENABLED, DISABLED
String
- - Name
Name of the custom endpoint
String
- - Type
Type of the origin server to bind. Enumerated values: REST, WEBSITE
String
- - ForcedReplacement
Replaces an existing configuration. Enumerated values: CNAME, TXT. If this parameter is configured, validation will be forced on the ownership of endpoint before the configuration is delivered.
String

Deleting a Custom Endpoint

API description

This API is used to delete the custom endpoint from a bucket.

Sample request

cos.deleteBucketDomain({
Bucket: 'examplebucket-1250000000', /* Required */
Region: 'ap-beijing', /* Required */
}, function(err, data) {
console.log(err || data);
});

Parameter description

Parameter Name
Description
Type
Required
Bucket
Name of the bucket for which to delete the custom endpoint in the format: BucketName-APPID
String
Yes
Region
Bucket region. For the enumerated values, see Regions and Access Endpoints
String
Yes

Callback function description

function(err, data) { ... }
Parameter Name
Description
Type
err
Returns a network or service error when the request fails. If the request is successful, this is empty. For more information, see Error Codes.
Object
- statusCode
Returns an HTTP status code, such as 200, 403, and 404
Number
- headers
Returns headers
Object
data
Returns data when the request is successful. If the request fails, this is empty
Object
- statusCode
Returns an HTTP status code, such as 200, 403, and 404
Number
- headers
Returns headers
Object

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan