v20220105

package
v3.0.1257+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 5, 2025 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// CAM signature/authentication error.
	AUTHFAILURE = "AuthFailure"

	// Operation failed.
	FAILEDOPERATION = "FailedOperation"

	// Internal error.
	INTERNALERROR = "InternalError"

	// Internal error.
	INTERNALERROR_INTERNAL = "InternalError.Internal"

	// Parameter error.
	INVALIDPARAMETER = "InvalidParameter"

	// Report embedding error.
	INVALIDPARAMETER_EMBED = "InvalidParameter.Embed"

	// Parameter value error.
	INVALIDPARAMETERVALUE = "InvalidParameterValue"

	// The quota limit is exceeded.
	LIMITEXCEEDED = "LimitExceeded"

	// Parameters are missing.
	MISSINGPARAMETER = "MissingParameter"

	// The required parameter is missing.
	MISSINGPARAMETER_MISSINGPARAM = "MissingParameter.MissingParam"

	// Operation denied.
	OPERATIONDENIED = "OperationDenied"

	// Too many and frequent requests.
	REQUESTLIMITEXCEEDED = "RequestLimitExceeded"

	// Unauthorized operation.
	UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

	// Permission error.
	UNAUTHORIZEDOPERATION_AUTHORIZE = "UnauthorizedOperation.Authorize"

	// Unknown parameter error.
	UNKNOWNPARAMETER = "UnknownParameter"

	// The operation is not supported.
	UNSUPPORTEDOPERATION = "UnsupportedOperation"

	// Default business exception.
	UNSUPPORTEDOPERATION_BIERROR = "UnsupportedOperation.BIError"
)
View Source 
const APIVersion = "2022-01-05"

Variables

This section is empty.

Functions

This section is empty.

Types

type ApplyEmbedIntervalRequest 

type ApplyEmbedIntervalRequest struct {
	*tchttp.BaseRequest

	// Shares the project ID. Required.
	ProjectId *uint64 `json:"ProjectId,omitnil,omitempty" name:"ProjectId"`

	// Shares the page ID. This field is empty (0) for embedding a dashboard and is not passed for embedding ChatBI.
	PageId *uint64 `json:"PageId,omitnil,omitempty" name:"PageId"`

	// Token requiring extension.
	BIToken *string `json:"BIToken,omitnil,omitempty" name:"BIToken"`

	// Alternate field.
	ExtraParam *string `json:"ExtraParam,omitnil,omitempty" name:"ExtraParam"`

	// embed: page/dashboard embedding.
	// chatBIEmbed: ChatBI embedding.
	Intention *string `json:"Intention,omitnil,omitempty" name:"Intention"`

	// panel: dashboard; page: page.
	// project, during ChatBI embedding.
	Scope *string `json:"Scope,omitnil,omitempty" name:"Scope"`
}

func NewApplyEmbedIntervalRequest 

func NewApplyEmbedIntervalRequest() (request *ApplyEmbedIntervalRequest)

func (*ApplyEmbedIntervalRequest) FromJsonString 

func (r *ApplyEmbedIntervalRequest) 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 (*ApplyEmbedIntervalRequest) ToJsonString 

func (r *ApplyEmbedIntervalRequest) ToJsonString() string

type ApplyEmbedIntervalRequestParams 

type ApplyEmbedIntervalRequestParams struct {
	// Shares the project ID. Required.
	ProjectId *uint64 `json:"ProjectId,omitnil,omitempty" name:"ProjectId"`

	// Shares the page ID. This field is empty (0) for embedding a dashboard and is not passed for embedding ChatBI.
	PageId *uint64 `json:"PageId,omitnil,omitempty" name:"PageId"`

	// Token requiring extension.
	BIToken *string `json:"BIToken,omitnil,omitempty" name:"BIToken"`

	// Alternate field.
	ExtraParam *string `json:"ExtraParam,omitnil,omitempty" name:"ExtraParam"`

	// embed: page/dashboard embedding.
	// chatBIEmbed: ChatBI embedding.
	Intention *string `json:"Intention,omitnil,omitempty" name:"Intention"`

	// panel: dashboard; page: page.
	// project, during ChatBI embedding.
	Scope *string `json:"Scope,omitnil,omitempty" name:"Scope"`
}

Predefined struct for user

type ApplyEmbedIntervalResponse 

type ApplyEmbedIntervalResponse struct {
	*tchttp.BaseResponse
	Response *ApplyEmbedIntervalResponseParams `json:"Response"`
}

func NewApplyEmbedIntervalResponse 

func NewApplyEmbedIntervalResponse() (response *ApplyEmbedIntervalResponse)

func (*ApplyEmbedIntervalResponse) FromJsonString 

func (r *ApplyEmbedIntervalResponse) 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 (*ApplyEmbedIntervalResponse) ToJsonString 

func (r *ApplyEmbedIntervalResponse) ToJsonString() string

type ApplyEmbedIntervalResponseParams 

type ApplyEmbedIntervalResponseParams struct {
	// Custom error information object.
	// Note: This field may return null, indicating that no valid values can be obtained.
	ErrorInfo *ErrorInfo `json:"ErrorInfo,omitnil,omitempty" name:"ErrorInfo"`

	// Additional parameters.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Extra *string `json:"Extra,omitnil,omitempty" name:"Extra"`

	// Result data.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Data *ApplyEmbedTokenInfo `json:"Data,omitnil,omitempty" name:"Data"`

	// Result description.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Msg *string `json:"Msg,omitnil,omitempty" name:"Msg"`

	// 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 ApplyEmbedTokenInfo 

type ApplyEmbedTokenInfo struct {
	// Request result.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`
}

type Client 

type Client struct {
	common.Client
}

func NewClient 

func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)

func NewClientWithSecretId 

func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)

Deprecated

func (*Client) ApplyEmbedInterval 

func (c *Client) ApplyEmbedInterval(request *ApplyEmbedIntervalRequest) (response *ApplyEmbedIntervalResponse, err error)

ApplyEmbedInterval This API is used to extend the available time of a token with strong authentication.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INTERNALERROR_INTERNAL = "InternalError.Internal"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_EMBED = "InvalidParameter.Embed"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_MISSINGPARAM = "MissingParameter.MissingParam"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_AUTHORIZE = "UnauthorizedOperation.Authorize"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"
UNSUPPORTEDOPERATION_BIERROR = "UnsupportedOperation.BIError"

func (*Client) ApplyEmbedIntervalWithContext 

func (c *Client) ApplyEmbedIntervalWithContext(ctx context.Context, request *ApplyEmbedIntervalRequest) (response *ApplyEmbedIntervalResponse, err error)

ApplyEmbedInterval This API is used to extend the available time of a token with strong authentication.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INTERNALERROR_INTERNAL = "InternalError.Internal"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_EMBED = "InvalidParameter.Embed"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_MISSINGPARAM = "MissingParameter.MissingParam"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_AUTHORIZE = "UnauthorizedOperation.Authorize"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"
UNSUPPORTEDOPERATION_BIERROR = "UnsupportedOperation.BIError"

func (*Client) CreateDatasource 

func (c *Client) CreateDatasource(request *CreateDatasourceRequest) (response *CreateDatasourceResponse, err error)

CreateDatasource This API is used to create a data source.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INTERNALERROR_INTERNAL = "InternalError.Internal"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_MISSINGPARAM = "MissingParameter.MissingParam"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_AUTHORIZE = "UnauthorizedOperation.Authorize"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"
UNSUPPORTEDOPERATION_BIERROR = "UnsupportedOperation.BIError"

func (*Client) CreateDatasourceWithContext 

func (c *Client) CreateDatasourceWithContext(ctx context.Context, request *CreateDatasourceRequest) (response *CreateDatasourceResponse, err error)

CreateDatasource This API is used to create a data source.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INTERNALERROR_INTERNAL = "InternalError.Internal"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_MISSINGPARAM = "MissingParameter.MissingParam"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_AUTHORIZE = "UnauthorizedOperation.Authorize"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"
UNSUPPORTEDOPERATION_BIERROR = "UnsupportedOperation.BIError"

type CreateDatasourceRequest 

type CreateDatasourceRequest struct {
	*tchttp.BaseRequest

	// HOST
	DbHost *string `json:"DbHost,omitnil,omitempty" name:"DbHost"`

	// Port.
	DbPort *uint64 `json:"DbPort,omitnil,omitempty" name:"DbPort"`

	// The backend provides dictionaries: domain type. 1. Tencent Cloud, 2. local.
	ServiceType *string `json:"ServiceType,omitnil,omitempty" name:"ServiceType"`

	// Drive.
	DbType *string `json:"DbType,omitnil,omitempty" name:"DbType"`

	// Database encoding.
	Charset *string `json:"Charset,omitnil,omitempty" name:"Charset"`

	// Username.
	DbUser *string `json:"DbUser,omitnil,omitempty" name:"DbUser"`

	// Password.
	DbPwd *string `json:"DbPwd,omitnil,omitempty" name:"DbPwd"`

	// Database name.
	DbName *string `json:"DbName,omitnil,omitempty" name:"DbName"`

	// Database alias.
	SourceName *string `json:"SourceName,omitnil,omitempty" name:"SourceName"`

	// Project ID.
	ProjectId *uint64 `json:"ProjectId,omitnil,omitempty" name:"ProjectId"`

	// Catalog value.
	Catalog *string `json:"Catalog,omitnil,omitempty" name:"Catalog"`

	// Third-party data source identifier.
	DataOrigin *string `json:"DataOrigin,omitnil,omitempty" name:"DataOrigin"`

	// Third-party project ID.
	DataOriginProjectId *string `json:"DataOriginProjectId,omitnil,omitempty" name:"DataOriginProjectId"`

	// Third-party data source ID.
	DataOriginDatasourceId *string `json:"DataOriginDatasourceId,omitnil,omitempty" name:"DataOriginDatasourceId"`

	// Extension parameter.
	ExtraParam *string `json:"ExtraParam,omitnil,omitempty" name:"ExtraParam"`

	// Unified identifier of the Tencent Cloud VPC.
	UniqVpcId *string `json:"UniqVpcId,omitnil,omitempty" name:"UniqVpcId"`

	// VPC IP address.
	Vip *string `json:"Vip,omitnil,omitempty" name:"Vip"`

	// VPC port.
	Vport *string `json:"Vport,omitnil,omitempty" name:"Vport"`

	// Tencent Cloud VPC identifier.
	VpcId *string `json:"VpcId,omitnil,omitempty" name:"VpcId"`

	// Operation permission limitation.
	OperationAuthLimit []*string `json:"OperationAuthLimit,omitnil,omitempty" name:"OperationAuthLimit"`

	// Enables VPC.
	UseVPC *bool `json:"UseVPC,omitnil,omitempty" name:"UseVPC"`

	// Region.
	RegionId *string `json:"RegionId,omitnil,omitempty" name:"RegionId"`
}

func NewCreateDatasourceRequest 

func NewCreateDatasourceRequest() (request *CreateDatasourceRequest)

func (*CreateDatasourceRequest) FromJsonString 

func (r *CreateDatasourceRequest) 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 (*CreateDatasourceRequest) ToJsonString 

func (r *CreateDatasourceRequest) ToJsonString() string

type CreateDatasourceRequestParams 

type CreateDatasourceRequestParams struct {
	// HOST
	DbHost *string `json:"DbHost,omitnil,omitempty" name:"DbHost"`

	// Port.
	DbPort *uint64 `json:"DbPort,omitnil,omitempty" name:"DbPort"`

	// The backend provides dictionaries: domain type. 1. Tencent Cloud, 2. local.
	ServiceType *string `json:"ServiceType,omitnil,omitempty" name:"ServiceType"`

	// Drive.
	DbType *string `json:"DbType,omitnil,omitempty" name:"DbType"`

	// Database encoding.
	Charset *string `json:"Charset,omitnil,omitempty" name:"Charset"`

	// Username.
	DbUser *string `json:"DbUser,omitnil,omitempty" name:"DbUser"`

	// Password.
	DbPwd *string `json:"DbPwd,omitnil,omitempty" name:"DbPwd"`

	// Database name.
	DbName *string `json:"DbName,omitnil,omitempty" name:"DbName"`

	// Database alias.
	SourceName *string `json:"SourceName,omitnil,omitempty" name:"SourceName"`

	// Project ID.
	ProjectId *uint64 `json:"ProjectId,omitnil,omitempty" name:"ProjectId"`

	// Catalog value.
	Catalog *string `json:"Catalog,omitnil,omitempty" name:"Catalog"`

	// Third-party data source identifier.
	DataOrigin *string `json:"DataOrigin,omitnil,omitempty" name:"DataOrigin"`

	// Third-party project ID.
	DataOriginProjectId *string `json:"DataOriginProjectId,omitnil,omitempty" name:"DataOriginProjectId"`

	// Third-party data source ID.
	DataOriginDatasourceId *string `json:"DataOriginDatasourceId,omitnil,omitempty" name:"DataOriginDatasourceId"`

	// Extension parameter.
	ExtraParam *string `json:"ExtraParam,omitnil,omitempty" name:"ExtraParam"`

	// Unified identifier of the Tencent Cloud VPC.
	UniqVpcId *string `json:"UniqVpcId,omitnil,omitempty" name:"UniqVpcId"`

	// VPC IP address.
	Vip *string `json:"Vip,omitnil,omitempty" name:"Vip"`

	// VPC port.
	Vport *string `json:"Vport,omitnil,omitempty" name:"Vport"`

	// Tencent Cloud VPC identifier.
	VpcId *string `json:"VpcId,omitnil,omitempty" name:"VpcId"`

	// Operation permission limitation.
	OperationAuthLimit []*string `json:"OperationAuthLimit,omitnil,omitempty" name:"OperationAuthLimit"`

	// Enables VPC.
	UseVPC *bool `json:"UseVPC,omitnil,omitempty" name:"UseVPC"`

	// Region.
	RegionId *string `json:"RegionId,omitnil,omitempty" name:"RegionId"`
}

Predefined struct for user

type CreateDatasourceResponse 

type CreateDatasourceResponse struct {
	*tchttp.BaseResponse
	Response *CreateDatasourceResponseParams `json:"Response"`
}

func NewCreateDatasourceResponse 

func NewCreateDatasourceResponse() (response *CreateDatasourceResponse)

func (*CreateDatasourceResponse) FromJsonString 

func (r *CreateDatasourceResponse) 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 (*CreateDatasourceResponse) ToJsonString 

func (r *CreateDatasourceResponse) ToJsonString() string

type CreateDatasourceResponseParams 

type CreateDatasourceResponseParams struct {
	// Custom error information object.
	// Note: This field may return null, indicating that no valid values can be obtained.
	ErrorInfo *ErrorInfo `json:"ErrorInfo,omitnil,omitempty" name:"ErrorInfo"`

	// Data source ID.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Data *IdDTO `json:"Data,omitnil,omitempty" name:"Data"`

	// Additional information.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Extra *string `json:"Extra,omitnil,omitempty" name:"Extra"`

	// Prompt.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Msg *string `json:"Msg,omitnil,omitempty" name:"Msg"`

	// 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 ErrorInfo 

type ErrorInfo struct {
	// Error description field.
	// Note: This field may return null, indicating that no valid values can be obtained.
	ErrorTip *string `json:"ErrorTip,omitnil,omitempty" name:"ErrorTip"`

	// Original exception message.
	// Note: This field may return null, indicating that no valid values can be obtained.
	ErrorMessage *string `json:"ErrorMessage,omitnil,omitempty" name:"ErrorMessage"`

	// Error level field.
	// ERROR
	// WARN
	// INFO
	// Note: This field may return null, indicating that no valid values can be obtained.
	ErrorLevel *string `json:"ErrorLevel,omitnil,omitempty" name:"ErrorLevel"`

	// Documentation link.
	// Note: This field may return null, indicating that no valid values can be obtained.
	DocLink *string `json:"DocLink,omitnil,omitempty" name:"DocLink"`

	// Quick start guide.
	// Note: This field may return null, indicating that no valid values can be obtained.
	FAQ *string `json:"FAQ,omitnil,omitempty" name:"FAQ"`

	// Reserved field 1.
	// Note: This field may return null, indicating that no valid values can be obtained.
	ReservedField *string `json:"ReservedField,omitnil,omitempty" name:"ReservedField"`
}

type IdDTO 

type IdDTO struct {
	// Request ID.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Id *int64 `json:"Id,omitnil,omitempty" name:"Id"`

	// key
	// Note: This field may return null, indicating that no valid values can be obtained.
	AccessKey *string `json:"AccessKey,omitnil,omitempty" name:"AccessKey"`

	// id
	// Note: This field may return null, indicating that no valid values can be obtained.
	ProjectId *uint64 `json:"ProjectId,omitnil,omitempty" name:"ProjectId"`

	// Transaction ID.
	// Note: This field may return null, indicating that no valid values can be obtained.
	TranId *string `json:"TranId,omitnil,omitempty" name:"TranId"`

	// Transaction status.
	// Note: This field may return null, indicating that no valid values can be obtained.
	TranStatus *int64 `json:"TranStatus,omitnil,omitempty" name:"TranStatus"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.