Documentation
¶
Index ¶
- Constants
- type Client
- func (c *Client) CreateLibrary(request *CreateLibraryRequest) (response *CreateLibraryResponse, err error)
- func (c *Client) CreateLibraryWithContext(ctx context.Context, request *CreateLibraryRequest) (response *CreateLibraryResponse, err error)
- func (c *Client) DeleteLibrary(request *DeleteLibraryRequest) (response *DeleteLibraryResponse, err error)
- func (c *Client) DeleteLibraryWithContext(ctx context.Context, request *DeleteLibraryRequest) (response *DeleteLibraryResponse, err error)
- func (c *Client) DescribeLibraries(request *DescribeLibrariesRequest) (response *DescribeLibrariesResponse, err error)
- func (c *Client) DescribeLibrariesWithContext(ctx context.Context, request *DescribeLibrariesRequest) (response *DescribeLibrariesResponse, err error)
- func (c *Client) DescribeLibrarySecret(request *DescribeLibrarySecretRequest) (response *DescribeLibrarySecretResponse, err error)
- func (c *Client) DescribeLibrarySecretWithContext(ctx context.Context, request *DescribeLibrarySecretRequest) (response *DescribeLibrarySecretResponse, err error)
- func (c *Client) DescribeOfficialInstances(request *DescribeOfficialInstancesRequest) (response *DescribeOfficialInstancesResponse, err error)
- func (c *Client) DescribeOfficialInstancesWithContext(ctx context.Context, request *DescribeOfficialInstancesRequest) (response *DescribeOfficialInstancesResponse, err error)
- func (c *Client) DescribeOfficialOverview(request *DescribeOfficialOverviewRequest) (response *DescribeOfficialOverviewResponse, err error)
- func (c *Client) DescribeOfficialOverviewWithContext(ctx context.Context, request *DescribeOfficialOverviewRequest) (response *DescribeOfficialOverviewResponse, err error)
- func (c *Client) DescribeTrafficPackages(request *DescribeTrafficPackagesRequest) (response *DescribeTrafficPackagesResponse, err error)
- func (c *Client) DescribeTrafficPackagesWithContext(ctx context.Context, request *DescribeTrafficPackagesRequest) (response *DescribeTrafficPackagesResponse, err error)
- func (c *Client) ModifyLibrary(request *ModifyLibraryRequest) (response *ModifyLibraryResponse, err error)
- func (c *Client) ModifyLibraryWithContext(ctx context.Context, request *ModifyLibraryRequest) (response *ModifyLibraryResponse, err error)
- func (c *Client) SendSmsCode(request *SendSmsCodeRequest) (response *SendSmsCodeResponse, err error)
- func (c *Client) SendSmsCodeWithContext(ctx context.Context, request *SendSmsCodeRequest) (response *SendSmsCodeResponse, err error)
- func (c *Client) VerifySmsCode(request *VerifySmsCodeRequest) (response *VerifySmsCodeResponse, err error)
- func (c *Client) VerifySmsCodeWithContext(ctx context.Context, request *VerifySmsCodeRequest) (response *VerifySmsCodeResponse, err error)
- type CreateLibraryRequest
- type CreateLibraryRequestParams
- type CreateLibraryResponse
- type CreateLibraryResponseParams
- type DeleteLibraryRequest
- type DeleteLibraryRequestParams
- type DeleteLibraryResponse
- type DeleteLibraryResponseParams
- type DescribeLibrariesRequest
- type DescribeLibrariesRequestParams
- type DescribeLibrariesResponse
- type DescribeLibrariesResponseParams
- type DescribeLibrarySecretRequest
- type DescribeLibrarySecretRequestParams
- type DescribeLibrarySecretResponse
- type DescribeLibrarySecretResponseParams
- type DescribeOfficialInstancesRequest
- type DescribeOfficialInstancesRequestParams
- type DescribeOfficialInstancesResponse
- type DescribeOfficialInstancesResponseParams
- type DescribeOfficialOverviewRequest
- type DescribeOfficialOverviewRequestParams
- type DescribeOfficialOverviewResponse
- type DescribeOfficialOverviewResponseParams
- type DescribeTrafficPackagesRequest
- type DescribeTrafficPackagesRequestParams
- type DescribeTrafficPackagesResponse
- type DescribeTrafficPackagesResponseParams
- type Instance
- type Library
- type LibraryExtension
- type ModifyLibraryRequest
- type ModifyLibraryRequestParams
- type ModifyLibraryResponse
- type ModifyLibraryResponseParams
- type SendSmsCodeRequest
- type SendSmsCodeRequestParams
- type SendSmsCodeResponse
- type SendSmsCodeResponseParams
- type TrafficPackage
- type VerifySmsCodeRequest
- type VerifySmsCodeRequestParams
- type VerifySmsCodeResponse
- type VerifySmsCodeResponseParams
Constants ¶
const ( // Internal error. INTERNALERROR = "InternalError" // Media library resource deletion failed. INTERNALERROR_MODIFYRESOURCESTATUSFAIL = "InternalError.ModifyResourceStatusFail" // Post-Payment activation failed. INTERNALERROR_POSTPAIDFAIL = "InternalError.PostpaidFail" // Error occurs when sending sms verification code. INTERNALERROR_SENDSMS = "InternalError.SendSms" // Parameter value error. INVALIDPARAMETERVALUE = "InvalidParameterValue" // The bucket name is invalid. INVALIDPARAMETERVALUE_BUCKETNAMEINVALID = "InvalidParameterValue.BucketNameInvalid" // The bucket name does not belong to the current root account. INVALIDPARAMETERVALUE_BUCKETNAMENOTBELONGYOU = "InvalidParameterValue.BucketNameNotBelongYou" // The bucket does not exist or is not in the specified region. INVALIDPARAMETERVALUE_BUCKETNOTFOUND = "InvalidParameterValue.BucketNotFound" // The service no longer supports selected buckets. INVALIDPARAMETERVALUE_BUCKETNOTSUPPORT = "InvalidParameterValue.BucketNotSupport" // Bucket location is invalid. INVALIDPARAMETERVALUE_BUCKETREGIONINVALID = "InvalidParameterValue.BucketRegionInvalid" // The specified storage class is invalid. INVALIDPARAMETERVALUE_COSSTORAGECLASS = "InvalidParameterValue.CosStorageClass" // The specified bucket does not have intelligent tiering storage enabled. activate the intelligent tiering storage feature for the bucket first. INVALIDPARAMETERVALUE_COSSTORAGECLASSINTELLIGENTTIERING = "InvalidParameterValue.CosStorageClassIntelligentTiering" // The specified country code is invalid. INVALIDPARAMETERVALUE_COUNTRYCODE = "InvalidParameterValue.CountryCode" // The number of parameter values or characters exceeds the limit. INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded" // The specified phone number is the same as the current one. INVALIDPARAMETERVALUE_NOTMODIFIED = "InvalidParameterValue.NotModified" // The specified phone number is not the super administrator of the enterprise. INVALIDPARAMETERVALUE_NOTSUPERADMIN = "InvalidParameterValue.NotSuperAdmin" // The specified phone number is invalid. INVALIDPARAMETERVALUE_PHONENUMBER = "InvalidParameterValue.PhoneNumber" // The number of users has been reached. please first upgrade the product spec. LIMITEXCEEDED_USERLIMIT = "LimitExceeded.UserLimit" // The sms verification code sent to the designated mobile number has reached the rate limit. REQUESTLIMITEXCEEDED_SENDSMS = "RequestLimitExceeded.SendSms" // A tenant space in the multi-tenant media library is in use. RESOURCEINUSE_MULTISPACE = "ResourceInUse.MultiSpace" // The media library does not exist or does not belong to the current account. RESOURCENOTFOUND_LIBRARY = "ResourceNotFound.Library" // The official cloud disk instance does not exist or does not belong to the current account. RESOURCENOTFOUND_OFFICIALINSTANCE = "ResourceNotFound.OfficialInstance" // cam:PassRole permission is not granted. UNAUTHORIZEDOPERATION_PASSROLE = "UnauthorizedOperation.PassRole" // SMH service-related role is not granted. UNAUTHORIZEDOPERATION_SERVICELINKEDROLE = "UnauthorizedOperation.ServiceLinkedRole" // Incorrect or expired sms verification code. UNAUTHORIZEDOPERATION_SMSCODE = "UnauthorizedOperation.SmsCode" // SMS verification code verification count exceeded. please resend the sms verification code. UNAUTHORIZEDOPERATION_SMSCODEEXCEEDED = "UnauthorizedOperation.SmsCodeExceeded" // Insufficient account balance. UNSUPPORTEDOPERATION_BALANCELESS = "UnsupportedOperation.BalanceLess" // The specified purpose is unsupported. UNSUPPORTEDOPERATION_PURPOSE = "UnsupportedOperation.Purpose" )
const APIVersion = "2021-07-12"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
func NewClient ¶
func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)
func NewClientWithSecretId ¶
Deprecated
func (*Client) CreateLibrary ¶
func (c *Client) CreateLibrary(request *CreateLibraryRequest) (response *CreateLibraryResponse, err error)
CreateLibrary This API is used to create a PaaS service media library.
error code that may be returned:
INTERNALERROR = "InternalError" INTERNALERROR_POSTPAIDFAIL = "InternalError.PostpaidFail" INVALIDPARAMETERVALUE = "InvalidParameterValue" INVALIDPARAMETERVALUE_BUCKETNAMEINVALID = "InvalidParameterValue.BucketNameInvalid" INVALIDPARAMETERVALUE_BUCKETNAMENOTBELONGYOU = "InvalidParameterValue.BucketNameNotBelongYou" INVALIDPARAMETERVALUE_BUCKETNOTFOUND = "InvalidParameterValue.BucketNotFound" INVALIDPARAMETERVALUE_BUCKETNOTSUPPORT = "InvalidParameterValue.BucketNotSupport" INVALIDPARAMETERVALUE_BUCKETREGIONINVALID = "InvalidParameterValue.BucketRegionInvalid" INVALIDPARAMETERVALUE_COSSTORAGECLASS = "InvalidParameterValue.CosStorageClass" INVALIDPARAMETERVALUE_COSSTORAGECLASSINTELLIGENTTIERING = "InvalidParameterValue.CosStorageClassIntelligentTiering" UNAUTHORIZEDOPERATION_PASSROLE = "UnauthorizedOperation.PassRole" UNAUTHORIZEDOPERATION_SERVICELINKEDROLE = "UnauthorizedOperation.ServiceLinkedRole" UNSUPPORTEDOPERATION_BALANCELESS = "UnsupportedOperation.BalanceLess"
func (*Client) CreateLibraryWithContext ¶
func (c *Client) CreateLibraryWithContext(ctx context.Context, request *CreateLibraryRequest) (response *CreateLibraryResponse, err error)
CreateLibrary This API is used to create a PaaS service media library.
error code that may be returned:
INTERNALERROR = "InternalError" INTERNALERROR_POSTPAIDFAIL = "InternalError.PostpaidFail" INVALIDPARAMETERVALUE = "InvalidParameterValue" INVALIDPARAMETERVALUE_BUCKETNAMEINVALID = "InvalidParameterValue.BucketNameInvalid" INVALIDPARAMETERVALUE_BUCKETNAMENOTBELONGYOU = "InvalidParameterValue.BucketNameNotBelongYou" INVALIDPARAMETERVALUE_BUCKETNOTFOUND = "InvalidParameterValue.BucketNotFound" INVALIDPARAMETERVALUE_BUCKETNOTSUPPORT = "InvalidParameterValue.BucketNotSupport" INVALIDPARAMETERVALUE_BUCKETREGIONINVALID = "InvalidParameterValue.BucketRegionInvalid" INVALIDPARAMETERVALUE_COSSTORAGECLASS = "InvalidParameterValue.CosStorageClass" INVALIDPARAMETERVALUE_COSSTORAGECLASSINTELLIGENTTIERING = "InvalidParameterValue.CosStorageClassIntelligentTiering" UNAUTHORIZEDOPERATION_PASSROLE = "UnauthorizedOperation.PassRole" UNAUTHORIZEDOPERATION_SERVICELINKEDROLE = "UnauthorizedOperation.ServiceLinkedRole" UNSUPPORTEDOPERATION_BALANCELESS = "UnsupportedOperation.BalanceLess"
func (*Client) DeleteLibrary ¶
func (c *Client) DeleteLibrary(request *DeleteLibraryRequest) (response *DeleteLibraryResponse, err error)
DeleteLibrary This API is used to delete a PaaS service media library.
error code that may be returned:
INTERNALERROR = "InternalError" INTERNALERROR_MODIFYRESOURCESTATUSFAIL = "InternalError.ModifyResourceStatusFail" RESOURCEINUSE_MULTISPACE = "ResourceInUse.MultiSpace" RESOURCENOTFOUND_LIBRARY = "ResourceNotFound.Library"
func (*Client) DeleteLibraryWithContext ¶
func (c *Client) DeleteLibraryWithContext(ctx context.Context, request *DeleteLibraryRequest) (response *DeleteLibraryResponse, err error)
DeleteLibrary This API is used to delete a PaaS service media library.
error code that may be returned:
INTERNALERROR = "InternalError" INTERNALERROR_MODIFYRESOURCESTATUSFAIL = "InternalError.ModifyResourceStatusFail" RESOURCEINUSE_MULTISPACE = "ResourceInUse.MultiSpace" RESOURCENOTFOUND_LIBRARY = "ResourceNotFound.Library"
func (*Client) DescribeLibraries ¶
func (c *Client) DescribeLibraries(request *DescribeLibrariesRequest) (response *DescribeLibrariesResponse, err error)
DescribeLibraries This API is used to query the PaaS service repository list.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded"
func (*Client) DescribeLibrariesWithContext ¶
func (c *Client) DescribeLibrariesWithContext(ctx context.Context, request *DescribeLibrariesRequest) (response *DescribeLibrariesResponse, err error)
DescribeLibraries This API is used to query the PaaS service repository list.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded"
func (*Client) DescribeLibrarySecret ¶
func (c *Client) DescribeLibrarySecret(request *DescribeLibrarySecretRequest) (response *DescribeLibrarySecretResponse, err error)
DescribeLibrarySecret This API is used to query the PaaS service Media Library Key.
error code that may be returned:
INTERNALERROR = "InternalError" RESOURCENOTFOUND_LIBRARY = "ResourceNotFound.Library"
func (*Client) DescribeLibrarySecretWithContext ¶
func (c *Client) DescribeLibrarySecretWithContext(ctx context.Context, request *DescribeLibrarySecretRequest) (response *DescribeLibrarySecretResponse, err error)
DescribeLibrarySecret This API is used to query the PaaS service Media Library Key.
error code that may be returned:
INTERNALERROR = "InternalError" RESOURCENOTFOUND_LIBRARY = "ResourceNotFound.Library"
func (*Client) DescribeOfficialInstances ¶
func (c *Client) DescribeOfficialInstances(request *DescribeOfficialInstancesRequest) (response *DescribeOfficialInstancesResponse, err error)
DescribeOfficialInstances This API is used to query official cloud disk instances.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded"
func (*Client) DescribeOfficialInstancesWithContext ¶
func (c *Client) DescribeOfficialInstancesWithContext(ctx context.Context, request *DescribeOfficialInstancesRequest) (response *DescribeOfficialInstancesResponse, err error)
DescribeOfficialInstances This API is used to query official cloud disk instances.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded"
func (*Client) DescribeOfficialOverview ¶
func (c *Client) DescribeOfficialOverview(request *DescribeOfficialOverviewRequest) (response *DescribeOfficialOverviewResponse, err error)
DescribeOfficialOverview This API is used to query overview data of official cloud disk instances.
error code that may be returned:
INTERNALERROR = "InternalError"
func (*Client) DescribeOfficialOverviewWithContext ¶
func (c *Client) DescribeOfficialOverviewWithContext(ctx context.Context, request *DescribeOfficialOverviewRequest) (response *DescribeOfficialOverviewResponse, err error)
DescribeOfficialOverview This API is used to query overview data of official cloud disk instances.
error code that may be returned:
INTERNALERROR = "InternalError"
func (*Client) DescribeTrafficPackages ¶
func (c *Client) DescribeTrafficPackages(request *DescribeTrafficPackagesRequest) (response *DescribeTrafficPackagesResponse, err error)
DescribeTrafficPackages This API is used to query traffic packages.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded"
func (*Client) DescribeTrafficPackagesWithContext ¶
func (c *Client) DescribeTrafficPackagesWithContext(ctx context.Context, request *DescribeTrafficPackagesRequest) (response *DescribeTrafficPackagesResponse, err error)
DescribeTrafficPackages This API is used to query traffic packages.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded"
func (*Client) ModifyLibrary ¶
func (c *Client) ModifyLibrary(request *ModifyLibraryRequest) (response *ModifyLibraryResponse, err error)
ModifyLibrary This API is used to modify the configuration items of a PaaS service media library.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded" RESOURCENOTFOUND_LIBRARY = "ResourceNotFound.Library"
func (*Client) ModifyLibraryWithContext ¶
func (c *Client) ModifyLibraryWithContext(ctx context.Context, request *ModifyLibraryRequest) (response *ModifyLibraryResponse, err error)
ModifyLibrary This API is used to modify the configuration items of a PaaS service media library.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded" RESOURCENOTFOUND_LIBRARY = "ResourceNotFound.Library"
func (*Client) SendSmsCode ¶
func (c *Client) SendSmsCode(request *SendSmsCodeRequest) (response *SendSmsCodeResponse, err error)
SendSmsCode This API is used to send SMS verification codes for changing the admin account of a super official cloud disk instance.
error code that may be returned:
INTERNALERROR_SENDSMS = "InternalError.SendSms" INVALIDPARAMETERVALUE_COUNTRYCODE = "InvalidParameterValue.CountryCode" INVALIDPARAMETERVALUE_NOTMODIFIED = "InvalidParameterValue.NotModified" INVALIDPARAMETERVALUE_NOTSUPERADMIN = "InvalidParameterValue.NotSuperAdmin" INVALIDPARAMETERVALUE_PHONENUMBER = "InvalidParameterValue.PhoneNumber" REQUESTLIMITEXCEEDED_SENDSMS = "RequestLimitExceeded.SendSms" RESOURCENOTFOUND_OFFICIALINSTANCE = "ResourceNotFound.OfficialInstance" UNSUPPORTEDOPERATION_PURPOSE = "UnsupportedOperation.Purpose"
func (*Client) SendSmsCodeWithContext ¶
func (c *Client) SendSmsCodeWithContext(ctx context.Context, request *SendSmsCodeRequest) (response *SendSmsCodeResponse, err error)
SendSmsCode This API is used to send SMS verification codes for changing the admin account of a super official cloud disk instance.
error code that may be returned:
INTERNALERROR_SENDSMS = "InternalError.SendSms" INVALIDPARAMETERVALUE_COUNTRYCODE = "InvalidParameterValue.CountryCode" INVALIDPARAMETERVALUE_NOTMODIFIED = "InvalidParameterValue.NotModified" INVALIDPARAMETERVALUE_NOTSUPERADMIN = "InvalidParameterValue.NotSuperAdmin" INVALIDPARAMETERVALUE_PHONENUMBER = "InvalidParameterValue.PhoneNumber" REQUESTLIMITEXCEEDED_SENDSMS = "RequestLimitExceeded.SendSms" RESOURCENOTFOUND_OFFICIALINSTANCE = "ResourceNotFound.OfficialInstance" UNSUPPORTEDOPERATION_PURPOSE = "UnsupportedOperation.Purpose"
func (*Client) VerifySmsCode ¶
func (c *Client) VerifySmsCode(request *VerifySmsCodeRequest) (response *VerifySmsCodeResponse, err error)
VerifySmsCode This API is used to verify the SMS verification code for rebinding the super administrator account of an official cloud disk instance.
error code that may be returned:
INVALIDPARAMETERVALUE_COUNTRYCODE = "InvalidParameterValue.CountryCode" INVALIDPARAMETERVALUE_PHONENUMBER = "InvalidParameterValue.PhoneNumber" LIMITEXCEEDED_USERLIMIT = "LimitExceeded.UserLimit" RESOURCENOTFOUND_OFFICIALINSTANCE = "ResourceNotFound.OfficialInstance" UNAUTHORIZEDOPERATION_SMSCODE = "UnauthorizedOperation.SmsCode" UNAUTHORIZEDOPERATION_SMSCODEEXCEEDED = "UnauthorizedOperation.SmsCodeExceeded" UNSUPPORTEDOPERATION_PURPOSE = "UnsupportedOperation.Purpose"
func (*Client) VerifySmsCodeWithContext ¶
func (c *Client) VerifySmsCodeWithContext(ctx context.Context, request *VerifySmsCodeRequest) (response *VerifySmsCodeResponse, err error)
VerifySmsCode This API is used to verify the SMS verification code for rebinding the super administrator account of an official cloud disk instance.
error code that may be returned:
INVALIDPARAMETERVALUE_COUNTRYCODE = "InvalidParameterValue.CountryCode" INVALIDPARAMETERVALUE_PHONENUMBER = "InvalidParameterValue.PhoneNumber" LIMITEXCEEDED_USERLIMIT = "LimitExceeded.UserLimit" RESOURCENOTFOUND_OFFICIALINSTANCE = "ResourceNotFound.OfficialInstance" UNAUTHORIZEDOPERATION_SMSCODE = "UnauthorizedOperation.SmsCode" UNAUTHORIZEDOPERATION_SMSCODEEXCEEDED = "UnauthorizedOperation.SmsCodeExceeded" UNSUPPORTEDOPERATION_PURPOSE = "UnsupportedOperation.Purpose"
type CreateLibraryRequest ¶
type CreateLibraryRequest struct {
*tchttp.BaseRequest
// Media library name. up to 50 characters.
Name *string `json:"Name,omitnil,omitempty" name:"Name"`
// Specifies the remark, up to 250 characters.
Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
// Specifies the full name of the bucket, which cannot be changed after creation. the current version no longer supports specified buckets.
BucketName *string `json:"BucketName,omitnil,omitempty" name:"BucketName"`
// Bucket location cannot be changed after creation. the current version no longer supports specifying bucket location.
BucketRegion *string `json:"BucketRegion,omitnil,omitempty" name:"BucketRegion"`
// Media library configuration item. some parameters cannot be changed after creation.
LibraryExtension *LibraryExtension `json:"LibraryExtension,omitnil,omitempty" name:"LibraryExtension"`
}
func NewCreateLibraryRequest ¶
func NewCreateLibraryRequest() (request *CreateLibraryRequest)
func (*CreateLibraryRequest) FromJsonString ¶
func (r *CreateLibraryRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateLibraryRequest) ToJsonString ¶
func (r *CreateLibraryRequest) ToJsonString() string
type CreateLibraryRequestParams ¶
type CreateLibraryRequestParams struct {
// Media library name. up to 50 characters.
Name *string `json:"Name,omitnil,omitempty" name:"Name"`
// Specifies the remark, up to 250 characters.
Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
// Specifies the full name of the bucket, which cannot be changed after creation. the current version no longer supports specified buckets.
BucketName *string `json:"BucketName,omitnil,omitempty" name:"BucketName"`
// Bucket location cannot be changed after creation. the current version no longer supports specifying bucket location.
BucketRegion *string `json:"BucketRegion,omitnil,omitempty" name:"BucketRegion"`
// Media library configuration item. some parameters cannot be changed after creation.
LibraryExtension *LibraryExtension `json:"LibraryExtension,omitnil,omitempty" name:"LibraryExtension"`
}
Predefined struct for user
type CreateLibraryResponse ¶
type CreateLibraryResponse struct {
*tchttp.BaseResponse
Response *CreateLibraryResponseParams `json:"Response"`
}
func NewCreateLibraryResponse ¶
func NewCreateLibraryResponse() (response *CreateLibraryResponse)
func (*CreateLibraryResponse) FromJsonString ¶
func (r *CreateLibraryResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateLibraryResponse) ToJsonString ¶
func (r *CreateLibraryResponse) ToJsonString() string
type CreateLibraryResponseParams ¶
type CreateLibraryResponseParams struct {
// Media library ID.
LibraryId *string `json:"LibraryId,omitnil,omitempty" name:"LibraryId"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DeleteLibraryRequest ¶
type DeleteLibraryRequest struct {
*tchttp.BaseRequest
// Media library ID.
LibraryId *string `json:"LibraryId,omitnil,omitempty" name:"LibraryId"`
}
func NewDeleteLibraryRequest ¶
func NewDeleteLibraryRequest() (request *DeleteLibraryRequest)
func (*DeleteLibraryRequest) FromJsonString ¶
func (r *DeleteLibraryRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteLibraryRequest) ToJsonString ¶
func (r *DeleteLibraryRequest) ToJsonString() string
type DeleteLibraryRequestParams ¶
type DeleteLibraryRequestParams struct {
// Media library ID.
LibraryId *string `json:"LibraryId,omitnil,omitempty" name:"LibraryId"`
}
Predefined struct for user
type DeleteLibraryResponse ¶
type DeleteLibraryResponse struct {
*tchttp.BaseResponse
Response *DeleteLibraryResponseParams `json:"Response"`
}
func NewDeleteLibraryResponse ¶
func NewDeleteLibraryResponse() (response *DeleteLibraryResponse)
func (*DeleteLibraryResponse) FromJsonString ¶
func (r *DeleteLibraryResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteLibraryResponse) ToJsonString ¶
func (r *DeleteLibraryResponse) ToJsonString() string
type DeleteLibraryResponseParams ¶
type DeleteLibraryResponseParams struct {
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DescribeLibrariesRequest ¶
type DescribeLibrariesRequest struct {
*tchttp.BaseRequest
// Specifies one or more media library ids for querying, with a maximum of 100 per request.
LibraryIds []*string `json:"LibraryIds,omitnil,omitempty" name:"LibraryIds"`
// Page number, int, used in conjunction with PageSize. default value is 1.
PageNumber *uint64 `json:"PageNumber,omitnil,omitempty" name:"PageNumber"`
// Number of items per page, integer, used in conjunction with PageNumber. default value is 20. maximum value is 100.
PageSize *uint64 `json:"PageSize,omitnil,omitempty" name:"PageSize"`
}
func NewDescribeLibrariesRequest ¶
func NewDescribeLibrariesRequest() (request *DescribeLibrariesRequest)
func (*DescribeLibrariesRequest) FromJsonString ¶
func (r *DescribeLibrariesRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeLibrariesRequest) ToJsonString ¶
func (r *DescribeLibrariesRequest) ToJsonString() string
type DescribeLibrariesRequestParams ¶
type DescribeLibrariesRequestParams struct {
// Specifies one or more media library ids for querying, with a maximum of 100 per request.
LibraryIds []*string `json:"LibraryIds,omitnil,omitempty" name:"LibraryIds"`
// Page number, int, used in conjunction with PageSize. default value is 1.
PageNumber *uint64 `json:"PageNumber,omitnil,omitempty" name:"PageNumber"`
// Number of items per page, integer, used in conjunction with PageNumber. default value is 20. maximum value is 100.
PageSize *uint64 `json:"PageSize,omitnil,omitempty" name:"PageSize"`
}
Predefined struct for user
type DescribeLibrariesResponse ¶
type DescribeLibrariesResponse struct {
*tchttp.BaseResponse
Response *DescribeLibrariesResponseParams `json:"Response"`
}
func NewDescribeLibrariesResponse ¶
func NewDescribeLibrariesResponse() (response *DescribeLibrariesResponse)
func (*DescribeLibrariesResponse) FromJsonString ¶
func (r *DescribeLibrariesResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeLibrariesResponse) ToJsonString ¶
func (r *DescribeLibrariesResponse) ToJsonString() string
type DescribeLibrariesResponseParams ¶
type DescribeLibrariesResponseParams struct {
// Library list.
List []*Library `json:"List,omitnil,omitempty" name:"List"`
// Total number.
TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DescribeLibrarySecretRequest ¶
type DescribeLibrarySecretRequest struct {
*tchttp.BaseRequest
// Media library ID.
LibraryId *string `json:"LibraryId,omitnil,omitempty" name:"LibraryId"`
}
func NewDescribeLibrarySecretRequest ¶
func NewDescribeLibrarySecretRequest() (request *DescribeLibrarySecretRequest)
func (*DescribeLibrarySecretRequest) FromJsonString ¶
func (r *DescribeLibrarySecretRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeLibrarySecretRequest) ToJsonString ¶
func (r *DescribeLibrarySecretRequest) ToJsonString() string
type DescribeLibrarySecretRequestParams ¶
type DescribeLibrarySecretRequestParams struct {
// Media library ID.
LibraryId *string `json:"LibraryId,omitnil,omitempty" name:"LibraryId"`
}
Predefined struct for user
type DescribeLibrarySecretResponse ¶
type DescribeLibrarySecretResponse struct {
*tchttp.BaseResponse
Response *DescribeLibrarySecretResponseParams `json:"Response"`
}
func NewDescribeLibrarySecretResponse ¶
func NewDescribeLibrarySecretResponse() (response *DescribeLibrarySecretResponse)
func (*DescribeLibrarySecretResponse) FromJsonString ¶
func (r *DescribeLibrarySecretResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeLibrarySecretResponse) ToJsonString ¶
func (r *DescribeLibrarySecretResponse) ToJsonString() string
type DescribeLibrarySecretResponseParams ¶
type DescribeLibrarySecretResponseParams struct {
// Specifies the media library ID to query.
LibraryId *string `json:"LibraryId,omitnil,omitempty" name:"LibraryId"`
// Queried media library key.
LibrarySecret *string `json:"LibrarySecret,omitnil,omitempty" name:"LibrarySecret"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DescribeOfficialInstancesRequest ¶
type DescribeOfficialInstancesRequest struct {
*tchttp.BaseRequest
// Specifies whether to query the super admin account bound to the instance. default value is false.
SuperAdminAccount *bool `json:"SuperAdminAccount,omitnil,omitempty" name:"SuperAdminAccount"`
// Specifies one or more instance ids for querying, with a maximum of 100 per request.
InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"`
// Page number, int, used in conjunction with PageSize. default value is 1.
PageNumber *uint64 `json:"PageNumber,omitnil,omitempty" name:"PageNumber"`
// Number of items per page, integer, used in conjunction with PageNumber. default value is 20. maximum value is 100.
PageSize *uint64 `json:"PageSize,omitnil,omitempty" name:"PageSize"`
// Specifies the column to sort.
OrderBy *string `json:"OrderBy,omitnil,omitempty" name:"OrderBy"`
// Sorting method.
OrderByType *string `json:"OrderByType,omitnil,omitempty" name:"OrderByType"`
// Specifies the filter type for renewal management.
AutoRenew *uint64 `json:"AutoRenew,omitnil,omitempty" name:"AutoRenew"`
// Specifies whether the super admin account is bound to a mobile number.
BindPhone *bool `json:"BindPhone,omitnil,omitempty" name:"BindPhone"`
}
func NewDescribeOfficialInstancesRequest ¶
func NewDescribeOfficialInstancesRequest() (request *DescribeOfficialInstancesRequest)
func (*DescribeOfficialInstancesRequest) FromJsonString ¶
func (r *DescribeOfficialInstancesRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeOfficialInstancesRequest) ToJsonString ¶
func (r *DescribeOfficialInstancesRequest) ToJsonString() string
type DescribeOfficialInstancesRequestParams ¶
type DescribeOfficialInstancesRequestParams struct {
// Specifies whether to query the super admin account bound to the instance. default value is false.
SuperAdminAccount *bool `json:"SuperAdminAccount,omitnil,omitempty" name:"SuperAdminAccount"`
// Specifies one or more instance ids for querying, with a maximum of 100 per request.
InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"`
// Page number, int, used in conjunction with PageSize. default value is 1.
PageNumber *uint64 `json:"PageNumber,omitnil,omitempty" name:"PageNumber"`
// Number of items per page, integer, used in conjunction with PageNumber. default value is 20. maximum value is 100.
PageSize *uint64 `json:"PageSize,omitnil,omitempty" name:"PageSize"`
// Specifies the column to sort.
OrderBy *string `json:"OrderBy,omitnil,omitempty" name:"OrderBy"`
// Sorting method.
OrderByType *string `json:"OrderByType,omitnil,omitempty" name:"OrderByType"`
// Specifies the filter type for renewal management.
AutoRenew *uint64 `json:"AutoRenew,omitnil,omitempty" name:"AutoRenew"`
// Specifies whether the super admin account is bound to a mobile number.
BindPhone *bool `json:"BindPhone,omitnil,omitempty" name:"BindPhone"`
}
Predefined struct for user
type DescribeOfficialInstancesResponse ¶
type DescribeOfficialInstancesResponse struct {
*tchttp.BaseResponse
Response *DescribeOfficialInstancesResponseParams `json:"Response"`
}
func NewDescribeOfficialInstancesResponse ¶
func NewDescribeOfficialInstancesResponse() (response *DescribeOfficialInstancesResponse)
func (*DescribeOfficialInstancesResponse) FromJsonString ¶
func (r *DescribeOfficialInstancesResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeOfficialInstancesResponse) ToJsonString ¶
func (r *DescribeOfficialInstancesResponse) ToJsonString() string
type DescribeOfficialInstancesResponseParams ¶
type DescribeOfficialInstancesResponseParams struct {
// Instance list
List []*Instance `json:"List,omitnil,omitempty" name:"List"`
// Total number.
TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DescribeOfficialOverviewRequest ¶
type DescribeOfficialOverviewRequest struct {
*tchttp.BaseRequest
}
func NewDescribeOfficialOverviewRequest ¶
func NewDescribeOfficialOverviewRequest() (request *DescribeOfficialOverviewRequest)
func (*DescribeOfficialOverviewRequest) FromJsonString ¶
func (r *DescribeOfficialOverviewRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeOfficialOverviewRequest) ToJsonString ¶
func (r *DescribeOfficialOverviewRequest) ToJsonString() string
type DescribeOfficialOverviewRequestParams ¶
type DescribeOfficialOverviewRequestParams struct {
}
Predefined struct for user
type DescribeOfficialOverviewResponse ¶
type DescribeOfficialOverviewResponse struct {
*tchttp.BaseResponse
Response *DescribeOfficialOverviewResponseParams `json:"Response"`
}
func NewDescribeOfficialOverviewResponse ¶
func NewDescribeOfficialOverviewResponse() (response *DescribeOfficialOverviewResponse)
func (*DescribeOfficialOverviewResponse) FromJsonString ¶
func (r *DescribeOfficialOverviewResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeOfficialOverviewResponse) ToJsonString ¶
func (r *DescribeOfficialOverviewResponse) ToJsonString() string
type DescribeOfficialOverviewResponseParams ¶
type DescribeOfficialOverviewResponseParams struct {
// Specifies the instance count of cloud disks.
Quantity *uint64 `json:"Quantity,omitnil,omitempty" name:"Quantity"`
// Indicates the total storage already used in Bytes. since the number type has precision limitations, this field is a String type.
Storage *string `json:"Storage,omitnil,omitempty" name:"Storage"`
// Total number of users already allocated and used.
UserCount *uint64 `json:"UserCount,omitnil,omitempty" name:"UserCount"`
// Public network downstream traffic this month in Bytes. since the number type has precision limitations, this field is a String type.
InternetTraffic *string `json:"InternetTraffic,omitnil,omitempty" name:"InternetTraffic"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DescribeTrafficPackagesRequest ¶
type DescribeTrafficPackagesRequest struct {
*tchttp.BaseRequest
// Specifies one or more resource ids for querying, with a maximum of 100 per request.
ResourceIds []*string `json:"ResourceIds,omitnil,omitempty" name:"ResourceIds"`
// Page number, int, used in conjunction with PageSize. default value is 1.
PageNumber *uint64 `json:"PageNumber,omitnil,omitempty" name:"PageNumber"`
// Number of items per page, integer, used in conjunction with PageNumber. default value is 20. maximum value is 100.
PageSize *uint64 `json:"PageSize,omitnil,omitempty" name:"PageSize"`
// Specifies the column to sort.
OrderBy *string `json:"OrderBy,omitnil,omitempty" name:"OrderBy"`
// Sorting method.
OrderByType *string `json:"OrderByType,omitnil,omitempty" name:"OrderByType"`
// Specifies the source type filter criteria.
Type *uint64 `json:"Type,omitnil,omitempty" name:"Type"`
}
func NewDescribeTrafficPackagesRequest ¶
func NewDescribeTrafficPackagesRequest() (request *DescribeTrafficPackagesRequest)
func (*DescribeTrafficPackagesRequest) FromJsonString ¶
func (r *DescribeTrafficPackagesRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeTrafficPackagesRequest) ToJsonString ¶
func (r *DescribeTrafficPackagesRequest) ToJsonString() string
type DescribeTrafficPackagesRequestParams ¶
type DescribeTrafficPackagesRequestParams struct {
// Specifies one or more resource ids for querying, with a maximum of 100 per request.
ResourceIds []*string `json:"ResourceIds,omitnil,omitempty" name:"ResourceIds"`
// Page number, int, used in conjunction with PageSize. default value is 1.
PageNumber *uint64 `json:"PageNumber,omitnil,omitempty" name:"PageNumber"`
// Number of items per page, integer, used in conjunction with PageNumber. default value is 20. maximum value is 100.
PageSize *uint64 `json:"PageSize,omitnil,omitempty" name:"PageSize"`
// Specifies the column to sort.
OrderBy *string `json:"OrderBy,omitnil,omitempty" name:"OrderBy"`
// Sorting method.
OrderByType *string `json:"OrderByType,omitnil,omitempty" name:"OrderByType"`
// Specifies the source type filter criteria.
Type *uint64 `json:"Type,omitnil,omitempty" name:"Type"`
}
Predefined struct for user
type DescribeTrafficPackagesResponse ¶
type DescribeTrafficPackagesResponse struct {
*tchttp.BaseResponse
Response *DescribeTrafficPackagesResponseParams `json:"Response"`
}
func NewDescribeTrafficPackagesResponse ¶
func NewDescribeTrafficPackagesResponse() (response *DescribeTrafficPackagesResponse)
func (*DescribeTrafficPackagesResponse) FromJsonString ¶
func (r *DescribeTrafficPackagesResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeTrafficPackagesResponse) ToJsonString ¶
func (r *DescribeTrafficPackagesResponse) ToJsonString() string
type DescribeTrafficPackagesResponseParams ¶
type DescribeTrafficPackagesResponseParams struct {
// Package list.
List []*TrafficPackage `json:"List,omitnil,omitempty" name:"List"`
// Total number.
TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type Instance ¶
type Instance struct {
// Instance ID.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Dedicated domain name. if the instance has no dedicated domain name, this attribute is null.
// Note: This field may return null, indicating that no valid values can be obtained.
Domain *string `json:"Domain,omitnil,omitempty" name:"Domain"`
// Effective time.
EffectiveTime *string `json:"EffectiveTime,omitnil,omitempty" name:"EffectiveTime"`
// Expiration time. if the instance is pay-as-you-go or permanently valid, this attribute is null.
// Note: This field may return null, indicating that no valid values can be obtained.
ExpireTime *string `json:"ExpireTime,omitnil,omitempty" name:"ExpireTime"`
// Number of users. if the instance uses pay-as-you-go billing or has unlimited users, this attribute is null.
// Note: This field may return null, indicating that no valid values can be obtained.
UserLimit *uint64 `json:"UserLimit,omitnil,omitempty" name:"UserLimit"`
// Storage capacity in Bytes. this field is of String type due to precision limitations of numeric types. this property is null for pay-as-you-go instances or instances with unlimited storage capacity.
// Note: This field may return null, indicating that no valid values can be obtained.
StorageLimit *string `json:"StorageLimit,omitnil,omitempty" name:"StorageLimit"`
// Storage capacity in GB. if the instance uses pay-as-you-go billing or has unlimited storage capacity, this attribute is null.
// Note: This field may return null, indicating that no valid values can be obtained.
StorageLimitGB *uint64 `json:"StorageLimitGB,omitnil,omitempty" name:"StorageLimitGB"`
// Is expired isolation.
Isolated *bool `json:"Isolated,omitnil,omitempty" name:"Isolated"`
// Renewal flag. 0: manual renewal; 1: automatic renewal; 2: non-renewal upon expiration.
AutoRenew *uint64 `json:"AutoRenew,omitnil,omitempty" name:"AutoRenew"`
// Specifies the super administrator account. if no selection query is made for the instance-bound super administrator account or the current instance is not bound to a super administrator account, this attribute is null.
// Note: This field may return null, indicating that no valid values can be obtained.
SuperAdminAccount *string `json:"SuperAdminAccount,omitnil,omitempty" name:"SuperAdminAccount"`
// In selected bucket mode, shows bucket usage.
Bucket *string `json:"Bucket,omitnil,omitempty" name:"Bucket"`
// Specifies the log bucket usage in selected mode.
// Note: This field may return null, indicating that no valid values can be obtained.
LogBucket *string `json:"LogBucket,omitnil,omitempty" name:"LogBucket"`
}
type Library ¶
type Library struct {
// Media library ID.
LibraryId *string `json:"LibraryId,omitnil,omitempty" name:"LibraryId"`
// Specifies the friendly name of the media library.
Name *string `json:"Name,omitnil,omitempty" name:"Name"`
// Remarks.
Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
// Specifies the COS storage bucket bound to the media library.
BucketName *string `json:"BucketName,omitnil,omitempty" name:"BucketName"`
// Specifies the region where the COS bucket bound to the media library is located.
BucketRegion *string `json:"BucketRegion,omitnil,omitempty" name:"BucketRegion"`
// Specifies the access domain of the business API for the media library.
AccessDomain *string `json:"AccessDomain,omitnil,omitempty" name:"AccessDomain"`
// Creation time of the media library.
CreationTime *string `json:"CreationTime,omitnil,omitempty" name:"CreationTime"`
// Media library configuration item.
LibraryExtension *LibraryExtension `json:"LibraryExtension,omitnil,omitempty" name:"LibraryExtension"`
// Media library amount in Bytes. since the number type has precision limitations, this field is a String type.
Size *string `json:"Size,omitnil,omitempty" name:"Size"`
// Number of media library directories. since the String type is used due to precision limitations of the number type, this field is of String type.
DirNum *string `json:"DirNum,omitnil,omitempty" name:"DirNum"`
// Number of files in the media library. since the String type is used due to precision limitations of the number type, this field is of String type.
FileNum *string `json:"FileNum,omitnil,omitempty" name:"FileNum"`
}
type LibraryExtension ¶
type LibraryExtension struct {
// Specifies whether it is a file type media library that can store any type of file (true) or a media type media library that can only store images and playable video types (false). defaults to false. cannot be modified once created.
IsFileLibrary *bool `json:"IsFileLibrary,omitnil,omitempty" name:"IsFileLibrary"`
// true indicates a multi-tenant space media library, allowing the creation of multiple tenant spaces. false indicates a single-tenant space media library, where tenant spaces cannot be created and only the default single tenant space can be used. defaults to false. cannot be modified after the media library is created.
IsMultiSpace *bool `json:"IsMultiSpace,omitnil,omitempty" name:"IsMultiSpace"`
// Specifies the storage type for files saved to cloud object storage. valid values: STANDARD, STANDARD_IA, INTELLIGENT_TIERING, MAZ_STANDARD, MAZ_STANDARD_IA, and MAZ_INTELLIGENT_TIERING. defaults to STANDARD. when using a multi-AZ bucket, MAZ_ prefixed storage types for multi-AZ are automatically used, otherwise non-MAZ_ prefixed storage types for non-multi-AZ are used. when specifying INTELLIGENT TIERING storage INTELLIGENT_TIERING or MAZ_INTELLIGENT_TIERING, the bucket must have INTELLIGENT TIERING storage enabled beforehand, otherwise failure will be returned. cannot be modified after the media library is created.
CosStorageClass *string `json:"CosStorageClass,omitnil,omitempty" name:"CosStorageClass"`
// Specifies whether the recycle bin feature is enabled. defaults to false.
UseRecycleBin *bool `json:"UseRecycleBin,omitnil,omitempty" name:"UseRecycleBin"`
// Specifies the number of days to automatically delete items in the recycle bin when enabled, must not exceed 1095 (3 years). a value of 0 indicates no automatic deletion, defaults to 0. this property is null when the recycle bin is not enabled.
// Note: This field may return null, indicating that no valid values can be obtained.
AutoRemoveRecycledDays *uint64 `json:"AutoRemoveRecycledDays,omitnil,omitempty" name:"AutoRemoveRecycledDays"`
// Whether to enable the file path search feature. is false by default.
EnableSearch *bool `json:"EnableSearch,omitnil,omitempty" name:"EnableSearch"`
// Specifies whether to deny the configuration request when setting the space quota for a media library or tenant and the quota is less than the used storage capacity. is false by default.
DenyOnQuotaLessThanUsage *bool `json:"DenyOnQuotaLessThanUsage,omitnil,omitempty" name:"DenyOnQuotaLessThanUsage"`
// Specifies whether the earlier version is enabled. defaults to false.
EnableFileHistory *bool `json:"EnableFileHistory,omitnil,omitempty" name:"EnableFileHistory"`
// Specifies the maximum number of historical versions to retain for a single file when versioning is enabled, with a value range of 1 to 999. this property may be null when versioning is not enabled.
// Note: This field may return null, indicating that no valid values can be obtained.
FileHistoryCount *uint64 `json:"FileHistoryCount,omitnil,omitempty" name:"FileHistoryCount"`
// Specifies the maximum days to retain earlier versions when versioning is enabled, with a value range of 0 to 999. when set to 0, it represents permanent retention. this property may be null when versioning is not enabled.
// Note: This field may return null, indicating that no valid values can be obtained.
FileHistoryExpireDay *uint64 `json:"FileHistoryExpireDay,omitnil,omitempty" name:"FileHistoryExpireDay"`
// The maximum length of a directory or file name must not exceed 255, with a default value of 255. modifying this parameter will not affect existing directories or file names. if the value of this field is decreased, the length of existing directories or file names exceeding the target value does not change.
MaxDirFileNameLength *uint64 `json:"MaxDirFileNameLength,omitnil,omitempty" name:"MaxDirFileNameLength"`
// Whether public read is enabled. once enabled, read operations require no access token. it is false by default. this property is supported only in single-tenant space media libraries. otherwise, it is null.
// Note: This field may return null, indicating that no valid values can be obtained.
IsPublicRead *bool `json:"IsPublicRead,omitnil,omitempty" name:"IsPublicRead"`
// Specifies whether the multi-album feature is enabled for the media type media library. once enabled, first-level directories (albums) can be created, and media files can only be saved in these albums. unless enabled, albums cannot be created, and media files can only be saved in the root directory. defaults to false. this property is only supported for single-tenant space media type media libraries, otherwise it is null. cannot be modified after the media library is created.
// Note: This field may return null, indicating that no valid values can be obtained.
IsMultiAlbum *bool `json:"IsMultiAlbum,omitnil,omitempty" name:"IsMultiAlbum"`
// Specifies whether the media library of the media type allows image uploads, set to true by default. this property is supported only for the media library of the media type in a single tenant space, otherwise it is null.
// Note: This field may return null, indicating that no valid values can be obtained.
AllowPhoto *bool `json:"AllowPhoto,omitnil,omitempty" name:"AllowPhoto"`
// Specifies the allowed extensions when the media type media library allows photo uploads. empty array by default. at this point, it will automatically determine based on the MIME type corresponding to the file extension. this property is supported only for single-tenant space media type media libraries. otherwise, the property is null.
// Note: This field may return null, indicating that no valid values can be obtained.
AllowPhotoExtName []*string `json:"AllowPhotoExtName,omitnil,omitempty" name:"AllowPhotoExtName"`
// Media type media library specifies whether video upload is allowed, set to true by default. this property is supported only in single tenant space media type media library, otherwise the property is null.
// Note: This field may return null, indicating that no valid values can be obtained.
AllowVideo *bool `json:"AllowVideo,omitnil,omitempty" name:"AllowVideo"`
// Specifies the allowed extensions when the media type media library permits video uploads. the default is an empty array, at which point it will automatically determine based on the MIME type corresponding to the file extension. this property is supported only for single-tenant space media type media libraries, otherwise it is null.
// Note: This field may return null, indicating that no valid values can be obtained.
AllowVideoExtName []*string `json:"AllowVideoExtName,omitnil,omitempty" name:"AllowVideoExtName"`
// Specifies the file extensions allowed in the file type media library, empty by default. at this point, all types of files are upload allowed. this property is supported only for the file type media library in a single tenant space, otherwise it is null.
// Note: This field may return null, indicating that no valid values can be obtained.
AllowFileExtName []*string `json:"AllowFileExtName,omitnil,omitempty" name:"AllowFileExtName"`
// Specifies whether to perform sensitive content identification during image upload. the value is false by default. this property is supported only in the single-tenant space media library, otherwise it is null.
// Note: This field may return null, indicating that no valid values can be obtained.
RecognizeSensitiveContent *bool `json:"RecognizeSensitiveContent,omitnil,omitempty" name:"RecognizeSensitiveContent"`
}
type ModifyLibraryRequest ¶
type ModifyLibraryRequest struct {
*tchttp.BaseRequest
// Media library ID.
LibraryId *string `json:"LibraryId,omitnil,omitempty" name:"LibraryId"`
// Media library name. up to 50 characters. leave empty to keep the current value.
Name *string `json:"Name,omitnil,omitempty" name:"Name"`
// Specifies the remark, up to 250 characters. leave it empty to keep the original value.
Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
// Media library configuration item. some parameters cannot be changed after creation and only modify passed parameters. if this parameter is not passed, no configuration item will be modified.
LibraryExtension *LibraryExtension `json:"LibraryExtension,omitnil,omitempty" name:"LibraryExtension"`
}
func NewModifyLibraryRequest ¶
func NewModifyLibraryRequest() (request *ModifyLibraryRequest)
func (*ModifyLibraryRequest) FromJsonString ¶
func (r *ModifyLibraryRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyLibraryRequest) ToJsonString ¶
func (r *ModifyLibraryRequest) ToJsonString() string
type ModifyLibraryRequestParams ¶
type ModifyLibraryRequestParams struct {
// Media library ID.
LibraryId *string `json:"LibraryId,omitnil,omitempty" name:"LibraryId"`
// Media library name. up to 50 characters. leave empty to keep the current value.
Name *string `json:"Name,omitnil,omitempty" name:"Name"`
// Specifies the remark, up to 250 characters. leave it empty to keep the original value.
Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
// Media library configuration item. some parameters cannot be changed after creation and only modify passed parameters. if this parameter is not passed, no configuration item will be modified.
LibraryExtension *LibraryExtension `json:"LibraryExtension,omitnil,omitempty" name:"LibraryExtension"`
}
Predefined struct for user
type ModifyLibraryResponse ¶
type ModifyLibraryResponse struct {
*tchttp.BaseResponse
Response *ModifyLibraryResponseParams `json:"Response"`
}
func NewModifyLibraryResponse ¶
func NewModifyLibraryResponse() (response *ModifyLibraryResponse)
func (*ModifyLibraryResponse) FromJsonString ¶
func (r *ModifyLibraryResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyLibraryResponse) ToJsonString ¶
func (r *ModifyLibraryResponse) ToJsonString() string
type ModifyLibraryResponseParams ¶
type ModifyLibraryResponseParams struct {
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type SendSmsCodeRequest ¶
type SendSmsCodeRequest struct {
*tchttp.BaseRequest
// Captcha target, currently supported: rebind super administrator account, BindSuperAdmin; trial version business upgrade, ChannelUpdateVerify.
Purpose *string `json:"Purpose,omitnil,omitempty" name:"Purpose"`
// Specifies the mobile number as the super admin account.
PhoneNumber *string `json:"PhoneNumber,omitnil,omitempty" name:"PhoneNumber"`
// Official cloud disk instance ID.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Specifies the country code of the mobile number that serves as the super administrator account. defaults to +86.
CountryCode *string `json:"CountryCode,omitnil,omitempty" name:"CountryCode"`
}
func NewSendSmsCodeRequest ¶
func NewSendSmsCodeRequest() (request *SendSmsCodeRequest)
func (*SendSmsCodeRequest) FromJsonString ¶
func (r *SendSmsCodeRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*SendSmsCodeRequest) ToJsonString ¶
func (r *SendSmsCodeRequest) ToJsonString() string
type SendSmsCodeRequestParams ¶
type SendSmsCodeRequestParams struct {
// Captcha target, currently supported: rebind super administrator account, BindSuperAdmin; trial version business upgrade, ChannelUpdateVerify.
Purpose *string `json:"Purpose,omitnil,omitempty" name:"Purpose"`
// Specifies the mobile number as the super admin account.
PhoneNumber *string `json:"PhoneNumber,omitnil,omitempty" name:"PhoneNumber"`
// Official cloud disk instance ID.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Specifies the country code of the mobile number that serves as the super administrator account. defaults to +86.
CountryCode *string `json:"CountryCode,omitnil,omitempty" name:"CountryCode"`
}
Predefined struct for user
type SendSmsCodeResponse ¶
type SendSmsCodeResponse struct {
*tchttp.BaseResponse
Response *SendSmsCodeResponseParams `json:"Response"`
}
func NewSendSmsCodeResponse ¶
func NewSendSmsCodeResponse() (response *SendSmsCodeResponse)
func (*SendSmsCodeResponse) FromJsonString ¶
func (r *SendSmsCodeResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*SendSmsCodeResponse) ToJsonString ¶
func (r *SendSmsCodeResponse) ToJsonString() string
type SendSmsCodeResponseParams ¶
type SendSmsCodeResponseParams struct {
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type TrafficPackage ¶
type TrafficPackage struct {
// Specifies the instance ID offset by the traffic package.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Dedicated domain name. if the instance has no dedicated domain name, this attribute is null.
// Note: This field may return null, indicating that no valid values can be obtained.
Domain *string `json:"Domain,omitnil,omitempty" name:"Domain"`
// Source type of the traffic package. valid values: 0 (purchase), 1 (complimentary).
Type *uint64 `json:"Type,omitnil,omitempty" name:"Type"`
// Total traffic in Bytes. since the number type has precision limitations, this field is a String type.
Size *string `json:"Size,omitnil,omitempty" name:"Size"`
// Total traffic in GB.
SizeGB *uint64 `json:"SizeGB,omitnil,omitempty" name:"SizeGB"`
// Remaining traffic in Bytes. this field is of String type due to precision limitations of numeric data types.
Remain *string `json:"Remain,omitnil,omitempty" name:"Remain"`
// Used traffic in Bytes. since the number type has precision limitations, this field is a String type.
Used *string `json:"Used,omitnil,omitempty" name:"Used"`
// Usage percentage. since the String type is used due to precision limitations of the number type, this field is of String type.
UsedPercentage *string `json:"UsedPercentage,omitnil,omitempty" name:"UsedPercentage"`
// Effective time, the order time of the traffic package.
EffectiveTime *string `json:"EffectiveTime,omitnil,omitempty" name:"EffectiveTime"`
// Expiration time, which is the expiration time of the offset instance. if the traffic package offsets a pay-as-you-go or permanently valid instance, this attribute is null.
// Note: This field may return null, indicating that no valid values can be obtained.
ExpireTime *string `json:"ExpireTime,omitnil,omitempty" name:"ExpireTime"`
}
type VerifySmsCodeRequest ¶
type VerifySmsCodeRequest struct {
*tchttp.BaseRequest
// Captcha target, currently supported: rebind super administrator account, BindSuperAdmin; trial version business upgrade verification, ChannelUpdateVerify.
Purpose *string `json:"Purpose,omitnil,omitempty" name:"Purpose"`
// Specifies the mobile number as the super admin account.
PhoneNumber *string `json:"PhoneNumber,omitnil,omitempty" name:"PhoneNumber"`
// Specifies the sms verification code.
Code *string `json:"Code,omitnil,omitempty" name:"Code"`
// Official cloud disk instance ID.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Specifies the country code of the mobile number that serves as the super administrator account. defaults to +86.
CountryCode *string `json:"CountryCode,omitnil,omitempty" name:"CountryCode"`
}
func NewVerifySmsCodeRequest ¶
func NewVerifySmsCodeRequest() (request *VerifySmsCodeRequest)
func (*VerifySmsCodeRequest) FromJsonString ¶
func (r *VerifySmsCodeRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*VerifySmsCodeRequest) ToJsonString ¶
func (r *VerifySmsCodeRequest) ToJsonString() string
type VerifySmsCodeRequestParams ¶
type VerifySmsCodeRequestParams struct {
// Captcha target, currently supported: rebind super administrator account, BindSuperAdmin; trial version business upgrade verification, ChannelUpdateVerify.
Purpose *string `json:"Purpose,omitnil,omitempty" name:"Purpose"`
// Specifies the mobile number as the super admin account.
PhoneNumber *string `json:"PhoneNumber,omitnil,omitempty" name:"PhoneNumber"`
// Specifies the sms verification code.
Code *string `json:"Code,omitnil,omitempty" name:"Code"`
// Official cloud disk instance ID.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Specifies the country code of the mobile number that serves as the super administrator account. defaults to +86.
CountryCode *string `json:"CountryCode,omitnil,omitempty" name:"CountryCode"`
}
Predefined struct for user
type VerifySmsCodeResponse ¶
type VerifySmsCodeResponse struct {
*tchttp.BaseResponse
Response *VerifySmsCodeResponseParams `json:"Response"`
}
func NewVerifySmsCodeResponse ¶
func NewVerifySmsCodeResponse() (response *VerifySmsCodeResponse)
func (*VerifySmsCodeResponse) FromJsonString ¶
func (r *VerifySmsCodeResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*VerifySmsCodeResponse) ToJsonString ¶
func (r *VerifySmsCodeResponse) ToJsonString() string
type VerifySmsCodeResponseParams ¶
type VerifySmsCodeResponseParams struct {
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user