v20220105

package
v1.0.445 Latest Latest
Warning

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

 Go to latest Published: Jul 18, 2022 License: Apache-2.0 Imports: 7 Imported by: 2

Documentation

Index

Constants

View Source 
const (

	// CAM签名/鉴权错误。
	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"
)
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

	// 分享项目id，必选
	ProjectId *uint64 `json:"ProjectId,omitempty" name:"ProjectId"`

	// 分享页面id，嵌出看板时此为空值0
	PageId *uint64 `json:"PageId,omitempty" name:"PageId"`

	// 需要申请延期的Token
	BIToken *string `json:"BIToken,omitempty" name:"BIToken"`

	// 备用字段
	ExtraParam *string `json:"ExtraParam,omitempty" name:"ExtraParam"`

	// panel,看板；page，页面
	Scope *string `json:"Scope,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 added in v1.0.426 

type ApplyEmbedIntervalRequestParams struct {
	// 分享项目id，必选
	ProjectId *uint64 `json:"ProjectId,omitempty" name:"ProjectId"`

	// 分享页面id，嵌出看板时此为空值0
	PageId *uint64 `json:"PageId,omitempty" name:"PageId"`

	// 需要申请延期的Token
	BIToken *string `json:"BIToken,omitempty" name:"BIToken"`

	// 备用字段
	ExtraParam *string `json:"ExtraParam,omitempty" name:"ExtraParam"`

	// panel,看板；page，页面
	Scope *string `json:"Scope,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 added in v1.0.426 

type ApplyEmbedIntervalResponseParams struct {
	// 额外参数
	// 注意：此字段可能返回 null，表示取不到有效值。
	Extra *string `json:"Extra,omitempty" name:"Extra"`

	// 结果数据
	// 注意：此字段可能返回 null，表示取不到有效值。
	Data *ApplyEmbedTokenInfo `json:"Data,omitempty" name:"Data"`

	// 结果描述
	// 注意：此字段可能返回 null，表示取不到有效值。
	Msg *string `json:"Msg,omitempty" name:"Msg"`

	// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type ApplyEmbedTokenInfo 

type ApplyEmbedTokenInfo struct {
	// 申请结果
	// 注意：此字段可能返回 null，表示取不到有效值。
	Result *bool `json:"Result,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 申请延长Token可用时间接口-强鉴权

可能返回的错误码: 

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 申请延长Token可用时间接口-强鉴权

可能返回的错误码: 

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) CreateEmbedToken 

func (c *Client) CreateEmbedToken(request *CreateEmbedTokenRequest) (response *CreateEmbedTokenResponse, err error)

CreateEmbedToken 创建嵌出报表-强鉴权

可能返回的错误码: 

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) CreateEmbedTokenWithContext 

func (c *Client) CreateEmbedTokenWithContext(ctx context.Context, request *CreateEmbedTokenRequest) (response *CreateEmbedTokenResponse, err error)

CreateEmbedToken 创建嵌出报表-强鉴权

可能返回的错误码: 

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"

type CreateEmbedTokenRequest 

type CreateEmbedTokenRequest struct {
	*tchttp.BaseRequest

	// 分享项目id，必选
	ProjectId *uint64 `json:"ProjectId,omitempty" name:"ProjectId"`

	// 分享页面id，嵌出看板时此为空值0
	PageId *uint64 `json:"PageId,omitempty" name:"PageId"`

	// page表示嵌出页面，panel表嵌出整个看板
	Scope *string `json:"Scope,omitempty" name:"Scope"`

	// 过期时间。 单位：分钟 最大值：240。即，4小时 默认值：240
	ExpireTime *string `json:"ExpireTime,omitempty" name:"ExpireTime"`

	// 备用字段
	ExtraParam *string `json:"ExtraParam,omitempty" name:"ExtraParam"`
}

func NewCreateEmbedTokenRequest 

func NewCreateEmbedTokenRequest() (request *CreateEmbedTokenRequest)

func (*CreateEmbedTokenRequest) FromJsonString 

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

func (r *CreateEmbedTokenRequest) ToJsonString() string

type CreateEmbedTokenRequestParams added in v1.0.426 

type CreateEmbedTokenRequestParams struct {
	// 分享项目id，必选
	ProjectId *uint64 `json:"ProjectId,omitempty" name:"ProjectId"`

	// 分享页面id，嵌出看板时此为空值0
	PageId *uint64 `json:"PageId,omitempty" name:"PageId"`

	// page表示嵌出页面，panel表嵌出整个看板
	Scope *string `json:"Scope,omitempty" name:"Scope"`

	// 过期时间。 单位：分钟 最大值：240。即，4小时 默认值：240
	ExpireTime *string `json:"ExpireTime,omitempty" name:"ExpireTime"`

	// 备用字段
	ExtraParam *string `json:"ExtraParam,omitempty" name:"ExtraParam"`
}

Predefined struct for user

type CreateEmbedTokenResponse 

type CreateEmbedTokenResponse struct {
	*tchttp.BaseResponse
	Response *CreateEmbedTokenResponseParams `json:"Response"`
}

func NewCreateEmbedTokenResponse 

func NewCreateEmbedTokenResponse() (response *CreateEmbedTokenResponse)

func (*CreateEmbedTokenResponse) FromJsonString 

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

func (r *CreateEmbedTokenResponse) ToJsonString() string

type CreateEmbedTokenResponseParams added in v1.0.426 

type CreateEmbedTokenResponseParams struct {
	// 额外信息
	// 注意：此字段可能返回 null，表示取不到有效值。
	Extra *string `json:"Extra,omitempty" name:"Extra"`

	// 数据
	// 注意：此字段可能返回 null，表示取不到有效值。
	Data *EmbedTokenInfo `json:"Data,omitempty" name:"Data"`

	// 结果描述
	// 注意：此字段可能返回 null，表示取不到有效值。
	Msg *string `json:"Msg,omitempty" name:"Msg"`

	// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type EmbedTokenInfo 

type EmbedTokenInfo struct {
	// 信息标识
	// 注意：此字段可能返回 null，表示取不到有效值。
	Id *uint64 `json:"Id,omitempty" name:"Id"`

	// 令牌
	// 注意：此字段可能返回 null，表示取不到有效值。
	BIToken *string `json:"BIToken,omitempty" name:"BIToken"`

	// 项目Id
	// 注意：此字段可能返回 null，表示取不到有效值。
	ProjectId *string `json:"ProjectId,omitempty" name:"ProjectId"`

	// 创建人
	// 注意：此字段可能返回 null，表示取不到有效值。
	CreatedUser *string `json:"CreatedUser,omitempty" name:"CreatedUser"`

	// 创建时间
	// 注意：此字段可能返回 null，表示取不到有效值。
	CreatedAt *string `json:"CreatedAt,omitempty" name:"CreatedAt"`

	// 更新人
	// 注意：此字段可能返回 null，表示取不到有效值。
	UpdatedUser *string `json:"UpdatedUser,omitempty" name:"UpdatedUser"`

	// 更新时间
	// 注意：此字段可能返回 null，表示取不到有效值。
	UpdatedAt *string `json:"UpdatedAt,omitempty" name:"UpdatedAt"`

	// 页面Id
	// 注意：此字段可能返回 null，表示取不到有效值。
	PageId *string `json:"PageId,omitempty" name:"PageId"`

	// 备用
	// 注意：此字段可能返回 null，表示取不到有效值。
	ExtraParam *string `json:"ExtraParam,omitempty" name:"ExtraParam"`

	// 嵌出类型
	// 注意：此字段可能返回 null，表示取不到有效值。
	Scope *string `json:"Scope,omitempty" name:"Scope"`

	// 过期时间，分钟为单位，最大240
	// 注意：此字段可能返回 null，表示取不到有效值。
	ExpireTime *uint64 `json:"ExpireTime,omitempty" name:"ExpireTime"`
}

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.