Documentation
¶
Overview ¶
Package sandbox include resources of ucloud sandbox product
See also
- API: https://docs.ucloud.cn/api/sandbox-api/index
- Product: https://www.ucloud.cn/site/product/sandbox.html
for detail.
Index ¶
- type CheckSandboxCustomDomainRequest
- type CheckSandboxCustomDomainResponse
- type CreateSandboxSiteRequest
- type CreateSandboxSiteResponse
- type DeleteSandboxSiteRequest
- type DeleteSandboxSiteResponse
- type GetSandboxSiteRequest
- type GetSandboxSiteResponse
- type ListSandboxSitesRequest
- type ListSandboxSitesResponse
- type SandboxClient
- func (c *SandboxClient) CheckSandboxCustomDomain(req *CheckSandboxCustomDomainRequest) (*CheckSandboxCustomDomainResponse, error)
- func (c *SandboxClient) CreateSandboxSite(req *CreateSandboxSiteRequest) (*CreateSandboxSiteResponse, error)
- func (c *SandboxClient) DeleteSandboxSite(req *DeleteSandboxSiteRequest) (*DeleteSandboxSiteResponse, error)
- func (c *SandboxClient) GetSandboxSite(req *GetSandboxSiteRequest) (*GetSandboxSiteResponse, error)
- func (c *SandboxClient) ListSandboxSites(req *ListSandboxSitesRequest) (*ListSandboxSitesResponse, error)
- func (c *SandboxClient) NewCheckSandboxCustomDomainRequest() *CheckSandboxCustomDomainRequest
- func (c *SandboxClient) NewCreateSandboxSiteRequest() *CreateSandboxSiteRequest
- func (c *SandboxClient) NewDeleteSandboxSiteRequest() *DeleteSandboxSiteRequest
- func (c *SandboxClient) NewGetSandboxSiteRequest() *GetSandboxSiteRequest
- func (c *SandboxClient) NewListSandboxSitesRequest() *ListSandboxSitesRequest
- func (c *SandboxClient) NewUpdateSandboxSiteCustomDomainRequest() *UpdateSandboxSiteCustomDomainRequest
- func (c *SandboxClient) NewUpdateSandboxSiteRequest() *UpdateSandboxSiteRequest
- func (c *SandboxClient) UpdateSandboxSite(req *UpdateSandboxSiteRequest) (*UpdateSandboxSiteResponse, error)
- func (c *SandboxClient) UpdateSandboxSiteCustomDomain(req *UpdateSandboxSiteCustomDomainRequest) (*UpdateSandboxSiteCustomDomainResponse, error)
- type Site
- type SiteIPAccess
- type UpdateSandboxSiteCustomDomainRequest
- type UpdateSandboxSiteCustomDomainResponse
- type UpdateSandboxSiteParamIPAccess
- type UpdateSandboxSiteRequest
- type UpdateSandboxSiteResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CheckSandboxCustomDomainRequest ¶
type CheckSandboxCustomDomainRequest struct {
request.CommonBase
// 自定义域名
CustomDomain *string `required:"true"`
// 如果为true,则表示获取检查结果
Get *bool `required:"false"`
// 目标域名
TargetDomain *string `required:"true"`
}
CheckSandboxCustomDomainRequest is request schema for CheckSandboxCustomDomain action
type CheckSandboxCustomDomainResponse ¶
type CheckSandboxCustomDomainResponse struct {
response.CommonBase
// 检查结果Unknown:未知Checking:检查中Success:成功Timeout:超时Error:检查失败
Status string
}
CheckSandboxCustomDomainResponse is response schema for CheckSandboxCustomDomain action
type CreateSandboxSiteRequest ¶
type CreateSandboxSiteRequest struct {
request.CommonBase
// 密钥
APIKey *string `required:"true"`
// 访问码
AccessCode *string `required:"true"`
// 环境变量,格式:["key=value"]
Envs *string `required:"false"`
// 密钥ID
KeyID *string `required:"true"`
// 站点空间名称
Name *string `required:"true"`
// 站点空间空间模版,格式:site-nc-ng,n为偶数
TemplateName *string `required:"true"`
}
CreateSandboxSiteRequest is request schema for CreateSandboxSite action
type CreateSandboxSiteResponse ¶
type CreateSandboxSiteResponse struct {
response.CommonBase
}
CreateSandboxSiteResponse is response schema for CreateSandboxSite action
type DeleteSandboxSiteRequest ¶
type DeleteSandboxSiteRequest struct {
request.CommonBase
// 站点沙箱ID
SandboxID *string `required:"true"`
}
DeleteSandboxSiteRequest is request schema for DeleteSandboxSite action
type DeleteSandboxSiteResponse ¶
type DeleteSandboxSiteResponse struct {
response.CommonBase
}
DeleteSandboxSiteResponse is response schema for DeleteSandboxSite action
type GetSandboxSiteRequest ¶
type GetSandboxSiteRequest struct {
request.CommonBase
// 沙箱ID
SandboxID *string `required:"true"`
}
GetSandboxSiteRequest is request schema for GetSandboxSite action
type GetSandboxSiteResponse ¶
type GetSandboxSiteResponse struct {
response.CommonBase
// 站点
Site Site
}
GetSandboxSiteResponse is response schema for GetSandboxSite action
type ListSandboxSitesRequest ¶
type ListSandboxSitesRequest struct {
request.CommonBase
}
ListSandboxSitesRequest is request schema for ListSandboxSites action
type ListSandboxSitesResponse ¶
type ListSandboxSitesResponse struct {
response.CommonBase
// 目标域名地址
CustomTargetDomain string
// 站点空间列表
Sites []Site
}
ListSandboxSitesResponse is response schema for ListSandboxSites action
type SandboxClient ¶
SandboxClient is the client of sandbox
func NewClient ¶
func NewClient(config *ucloud.Config, credential *auth.Credential) *SandboxClient
NewClient will return a instance of SandboxClient
func (*SandboxClient) CheckSandboxCustomDomain ¶
func (c *SandboxClient) CheckSandboxCustomDomain(req *CheckSandboxCustomDomainRequest) (*CheckSandboxCustomDomainResponse, error)
API: CheckSandboxCustomDomain
检查自定义域名
func (*SandboxClient) CreateSandboxSite ¶
func (c *SandboxClient) CreateSandboxSite(req *CreateSandboxSiteRequest) (*CreateSandboxSiteResponse, error)
API: CreateSandboxSite
创建站点空间
func (*SandboxClient) DeleteSandboxSite ¶
func (c *SandboxClient) DeleteSandboxSite(req *DeleteSandboxSiteRequest) (*DeleteSandboxSiteResponse, error)
API: DeleteSandboxSite
删除站点空间
func (*SandboxClient) GetSandboxSite ¶
func (c *SandboxClient) GetSandboxSite(req *GetSandboxSiteRequest) (*GetSandboxSiteResponse, error)
API: GetSandboxSite
获取沙箱站点
func (*SandboxClient) ListSandboxSites ¶
func (c *SandboxClient) ListSandboxSites(req *ListSandboxSitesRequest) (*ListSandboxSitesResponse, error)
API: ListSandboxSites
列出站点空间
func (*SandboxClient) NewCheckSandboxCustomDomainRequest ¶
func (c *SandboxClient) NewCheckSandboxCustomDomainRequest() *CheckSandboxCustomDomainRequest
NewCheckSandboxCustomDomainRequest will create request of CheckSandboxCustomDomain action.
func (*SandboxClient) NewCreateSandboxSiteRequest ¶
func (c *SandboxClient) NewCreateSandboxSiteRequest() *CreateSandboxSiteRequest
NewCreateSandboxSiteRequest will create request of CreateSandboxSite action.
func (*SandboxClient) NewDeleteSandboxSiteRequest ¶
func (c *SandboxClient) NewDeleteSandboxSiteRequest() *DeleteSandboxSiteRequest
NewDeleteSandboxSiteRequest will create request of DeleteSandboxSite action.
func (*SandboxClient) NewGetSandboxSiteRequest ¶
func (c *SandboxClient) NewGetSandboxSiteRequest() *GetSandboxSiteRequest
NewGetSandboxSiteRequest will create request of GetSandboxSite action.
func (*SandboxClient) NewListSandboxSitesRequest ¶
func (c *SandboxClient) NewListSandboxSitesRequest() *ListSandboxSitesRequest
NewListSandboxSitesRequest will create request of ListSandboxSites action.
func (*SandboxClient) NewUpdateSandboxSiteCustomDomainRequest ¶
func (c *SandboxClient) NewUpdateSandboxSiteCustomDomainRequest() *UpdateSandboxSiteCustomDomainRequest
NewUpdateSandboxSiteCustomDomainRequest will create request of UpdateSandboxSiteCustomDomain action.
func (*SandboxClient) NewUpdateSandboxSiteRequest ¶
func (c *SandboxClient) NewUpdateSandboxSiteRequest() *UpdateSandboxSiteRequest
NewUpdateSandboxSiteRequest will create request of UpdateSandboxSite action.
func (*SandboxClient) UpdateSandboxSite ¶
func (c *SandboxClient) UpdateSandboxSite(req *UpdateSandboxSiteRequest) (*UpdateSandboxSiteResponse, error)
API: UpdateSandboxSite
更新站点空间
func (*SandboxClient) UpdateSandboxSiteCustomDomain ¶
func (c *SandboxClient) UpdateSandboxSiteCustomDomain(req *UpdateSandboxSiteCustomDomainRequest) (*UpdateSandboxSiteCustomDomainResponse, error)
API: UpdateSandboxSiteCustomDomain
更新沙箱站点自定义域名
type Site ¶
type Site struct {
// 访问码
AccessCode string
// 连接密钥
ConnectKey string
// 自定义域名
CustomDomain string
// 自定义域名签发错误信息
CustomDomainError string
// 自定义域名签发状态
CustomDomainStatus string
// 站点环境变量。格式:["key=value"]
Envs []string
// 站点访问地址
Host string
// 站点ID
ID string
// IP限制
IPAccess SiteIPAccess
// 站点Key ID
KeyID string
// 名称
Name string
// 是否就绪
Ready bool
// 沙箱ID
SandboxID string
// 更新时间
UpdateTime int
}
Site - 站点空间
type SiteIPAccess ¶
type SiteIPAccess struct {
// IP 列表
IPList []string
// IP限制模式"":不限制IP“allow”:自定义白名单“deny”:自定义黑名单
Mode string
}
SiteIPAccess - 站点空间-访问设置-IP限制
type UpdateSandboxSiteCustomDomainRequest ¶
type UpdateSandboxSiteCustomDomainRequest struct {
request.CommonBase
// 自定义域名
CustomDomain *string `required:"true"`
// 沙箱ID
SandboxID *string `required:"true"`
}
UpdateSandboxSiteCustomDomainRequest is request schema for UpdateSandboxSiteCustomDomain action
type UpdateSandboxSiteCustomDomainResponse ¶
type UpdateSandboxSiteCustomDomainResponse struct {
response.CommonBase
}
UpdateSandboxSiteCustomDomainResponse is response schema for UpdateSandboxSiteCustomDomain action
type UpdateSandboxSiteParamIPAccess ¶
type UpdateSandboxSiteParamIPAccess struct {
// 访问限制IP,格式["192.168.1.2","192.168.1.3"]
IPList *string `required:"false"`
// 访问模式,- "":无IP限制- "allow":白名单模式- "deny":黑名单
Mode *string `required:"false"`
}
UpdateSandboxSiteParamIPAccess is request schema for complex param
type UpdateSandboxSiteRequest ¶
type UpdateSandboxSiteRequest struct {
request.CommonBase
// 更新站点空间API Key
APIKey *string `required:"false"`
// 访问码
AccessCode *string `required:"false"`
// 更新站点空间环境变量,格式为["Key=Value"]
Envs *string `required:"false"`
//
IPAccess *UpdateSandboxSiteParamIPAccess `required:"false"`
// 更新站点空间Key ID(需要和APIKey一起传)
KeyID *string `required:"false"`
// 更新站点空间名称
Name *string `required:"false"`
// 站点沙箱ID
SandboxID *string `required:"true"`
}
UpdateSandboxSiteRequest is request schema for UpdateSandboxSite action
type UpdateSandboxSiteResponse ¶
type UpdateSandboxSiteResponse struct {
response.CommonBase
}
UpdateSandboxSiteResponse is response schema for UpdateSandboxSite action