Documentation
¶
Index ¶
- Constants
- func DecodeError(statusCode int, body []byte) error
- func ErrorCode(err error) string
- func IsAccessDenied(err error) bool
- func NewHTTPClient() *http.Client
- func NewTransport() *http.Transport
- func ResolveEndpoint(service, region, siteStack string) string
- type APIError
- type AttachUserPolicyResponse
- type Client
- func (c *Client) AttachUserPolicy(ctx context.Context, region, userName, policyName, policyType string) (AttachUserPolicyResponse, error)
- func (c *Client) CreateCommand(ctx context.Context, ...) (CreateCommandResponse, error)
- func (c *Client) CreateLoginProfile(ctx context.Context, region, userName, password string) (CreateLoginProfileResponse, error)
- func (c *Client) CreateUser(ctx context.Context, region, userName, displayName string) (CreateUserResponse, error)
- func (c *Client) DeleteCommand(ctx context.Context, region, commandID string) (DeleteCommandResponse, error)
- func (c *Client) DeleteLoginProfile(ctx context.Context, region, userName string) (DeleteLoginProfileResponse, error)
- func (c *Client) DeleteUser(ctx context.Context, region, userName string) (DeleteUserResponse, error)
- func (c *Client) DescribeCloudAssistantStatus(ctx context.Context, region string, instanceIDs []string, osType string, ...) (DescribeCloudAssistantStatusResponse, error)
- func (c *Client) DescribeInstances(ctx context.Context, region string, maxResults int32, nextToken string) (DescribeInstancesResponse, error)
- func (c *Client) DescribeInvocationResults(ctx context.Context, region, invocationID, commandID, instanceID string, ...) (DescribeInvocationResultsResponse, error)
- func (c *Client) DescribeRDSMySQLInstances(ctx context.Context, region string, pageNumber, pageSize int32) (DescribeRDSMySQLInstancesResponse, error)
- func (c *Client) DescribeRDSPostgreSQLInstances(ctx context.Context, region string, pageNumber, pageSize int32) (DescribeRDSPostgreSQLInstancesResponse, error)
- func (c *Client) DescribeRDSRegions(ctx context.Context, service, region string) (DescribeRDSRegionsResponse, error)
- func (c *Client) DescribeRDSSQLServerInstances(ctx context.Context, region string, pageNumber, pageSize int32) (DescribeRDSSQLServerInstancesResponse, error)
- func (c *Client) DescribeRegions(ctx context.Context, region string, maxResults int32) (DescribeRegionsResponse, error)
- func (c *Client) DetachUserPolicy(ctx context.Context, region, userName, policyName, policyType string) (DetachUserPolicyResponse, error)
- func (c *Client) DoOpenAPI(ctx context.Context, req Request, out any) error
- func (c *Client) GetLoginProfile(ctx context.Context, region, userName string) (GetLoginProfileResponse, error)
- func (c *Client) InvokeCommand(ctx context.Context, region, commandID, invocationName string, ...) (InvokeCommandResponse, error)
- func (c *Client) ListDNSRecords(ctx context.Context, zid int64, pageNumber, pageSize int32) (ListDNSRecordsResponse, error)
- func (c *Client) ListDNSZones(ctx context.Context, pageNumber, pageSize int32) (ListDNSZonesResponse, error)
- func (c *Client) ListProjects(ctx context.Context, region string) (ListProjectsResponse, error)
- func (c *Client) ListUsers(ctx context.Context, region string, limit, offset int32) (ListUsersResponse, error)
- func (c *Client) QueryBalanceAcct(ctx context.Context, region string) (QueryBalanceAcctResponse, error)
- type CreateCommandResponse
- type CreateLoginProfileResponse
- type CreateUserResponse
- type DNSRecord
- type DNSZone
- type DeleteCommandResponse
- type DeleteLoginProfileResponse
- type DeleteUserResponse
- type DescribeCloudAssistantStatusResponse
- type DescribeInstancesResponse
- type DescribeInvocationResultsResponse
- type DescribeRDSMySQLInstancesResponse
- type DescribeRDSPostgreSQLInstancesResponse
- type DescribeRDSRegionsResponse
- type DescribeRDSSQLServerInstancesResponse
- type DescribeRegionsResponse
- type DetachUserPolicyResponse
- type ECSCloudAssistantInstance
- type ECSEipAddress
- type ECSInstance
- type ECSInvocationResult
- type ECSNetworkInterface
- type ECSRegion
- type ErrorBody
- type GetLoginProfileResponse
- type IAMLoginProfile
- type IAMProject
- type IAMUserMetadata
- type InvokeCommandResponse
- type ListDNSRecordsResponse
- type ListDNSZonesResponse
- type ListProjectsResponse
- type ListUsersResponse
- type Option
- type QueryBalanceAcctResponse
- type RDSAddressObject
- type RDSMySQLInstance
- type RDSPostgreSQLInstance
- type RDSRegion
- type RDSSQLServerInstance
- type RDSSQLServerNode
- type Request
- type ResponseMetadata
- type RetryPolicy
- type SignInput
- type Signature
Constants ¶
View Source
const ( Algorithm = "HMAC-SHA256" DateFormat = "20060102T150405Z" HeaderAuthorization = "Authorization" HeaderXDate = "X-Date" HeaderXContentSHA256 = "X-Content-Sha256" HeaderXSecurityToken = "X-Security-Token" )
View Source
const ( ServiceRDSMySQL = "rds_mysql" ServiceRDSPostgreSQL = "rds_postgresql" ServiceRDSMSSQL = "rds_mssql" )
View Source
const (
DefaultRegion = "cn-beijing"
)
View Source
const (
DefaultTimeout = 30 * time.Second
)
Variables ¶
This section is empty.
Functions ¶
func DecodeError ¶
func IsAccessDenied ¶ added in v0.2.5
func NewHTTPClient ¶
func NewTransport ¶
func ResolveEndpoint ¶
ResolveEndpoint returns the HTTPS base URL for a Volcengine OpenAPI service.
Types ¶
type APIError ¶
type AttachUserPolicyResponse ¶ added in v0.2.4
type AttachUserPolicyResponse struct {
ResponseMetadata ResponseMetadata `json:"ResponseMetadata"`
}
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func (*Client) AttachUserPolicy ¶ added in v0.2.4
func (*Client) CreateCommand ¶ added in v0.2.4
func (*Client) CreateLoginProfile ¶ added in v0.2.4
func (*Client) CreateUser ¶ added in v0.2.4
func (*Client) DeleteCommand ¶ added in v0.2.4
func (*Client) DeleteLoginProfile ¶ added in v0.2.4
func (*Client) DeleteUser ¶ added in v0.2.4
func (*Client) DescribeCloudAssistantStatus ¶ added in v0.2.4
func (*Client) DescribeInstances ¶
func (*Client) DescribeInvocationResults ¶ added in v0.2.4
func (*Client) DescribeRDSMySQLInstances ¶ added in v0.2.5
func (*Client) DescribeRDSPostgreSQLInstances ¶ added in v0.2.5
func (*Client) DescribeRDSRegions ¶ added in v0.2.5
func (*Client) DescribeRDSSQLServerInstances ¶ added in v0.2.5
func (*Client) DescribeRegions ¶
func (*Client) DetachUserPolicy ¶ added in v0.2.4
func (*Client) GetLoginProfile ¶
func (*Client) InvokeCommand ¶ added in v0.2.4
func (*Client) ListDNSRecords ¶ added in v0.2.5
func (*Client) ListDNSZones ¶ added in v0.2.5
func (*Client) ListProjects ¶
func (*Client) QueryBalanceAcct ¶
type CreateCommandResponse ¶ added in v0.2.4
type CreateCommandResponse struct {
ResponseMetadata ResponseMetadata `json:"ResponseMetadata"`
Result struct {
CommandID string `json:"CommandId"`
} `json:"Result"`
}
type CreateLoginProfileResponse ¶ added in v0.2.4
type CreateLoginProfileResponse struct {
ResponseMetadata ResponseMetadata `json:"ResponseMetadata"`
Result struct {
LoginProfile IAMLoginProfile `json:"LoginProfile"`
} `json:"Result"`
}
type CreateUserResponse ¶ added in v0.2.4
type CreateUserResponse struct {
ResponseMetadata ResponseMetadata `json:"ResponseMetadata"`
Result struct {
User IAMUserMetadata `json:"User"`
} `json:"Result"`
}
type DeleteCommandResponse ¶ added in v0.2.4
type DeleteCommandResponse struct {
ResponseMetadata ResponseMetadata `json:"ResponseMetadata"`
Result struct {
CommandID string `json:"CommandId"`
} `json:"Result"`
}
type DeleteLoginProfileResponse ¶ added in v0.2.4
type DeleteLoginProfileResponse struct {
ResponseMetadata ResponseMetadata `json:"ResponseMetadata"`
}
type DeleteUserResponse ¶ added in v0.2.4
type DeleteUserResponse struct {
ResponseMetadata ResponseMetadata `json:"ResponseMetadata"`
}
type DescribeCloudAssistantStatusResponse ¶ added in v0.2.4
type DescribeCloudAssistantStatusResponse struct {
ResponseMetadata ResponseMetadata `json:"ResponseMetadata"`
Result struct {
Instances []ECSCloudAssistantInstance `json:"Instances"`
PageNumber int32 `json:"PageNumber"`
PageSize int32 `json:"PageSize"`
TotalCount int32 `json:"TotalCount"`
} `json:"Result"`
}
type DescribeInstancesResponse ¶
type DescribeInstancesResponse struct {
ResponseMetadata ResponseMetadata `json:"ResponseMetadata"`
Result struct {
NextToken string `json:"NextToken"`
Instances []ECSInstance `json:"Instances"`
} `json:"Result"`
}
type DescribeInvocationResultsResponse ¶ added in v0.2.4
type DescribeInvocationResultsResponse struct {
ResponseMetadata ResponseMetadata `json:"ResponseMetadata"`
Result struct {
InvocationResults []ECSInvocationResult `json:"InvocationResults"`
PageNumber int32 `json:"PageNumber"`
PageSize int32 `json:"PageSize"`
TotalCount int32 `json:"TotalCount"`
} `json:"Result"`
}
type DescribeRDSMySQLInstancesResponse ¶ added in v0.2.5
type DescribeRDSMySQLInstancesResponse struct {
ResponseMetadata ResponseMetadata `json:"ResponseMetadata"`
Result struct {
Instances []RDSMySQLInstance `json:"Instances"`
Total int32 `json:"Total"`
} `json:"Result"`
}
type DescribeRDSPostgreSQLInstancesResponse ¶ added in v0.2.5
type DescribeRDSPostgreSQLInstancesResponse struct {
ResponseMetadata ResponseMetadata `json:"ResponseMetadata"`
Result struct {
Instances []RDSPostgreSQLInstance `json:"Instances"`
Total int32 `json:"Total"`
} `json:"Result"`
}
type DescribeRDSRegionsResponse ¶ added in v0.2.5
type DescribeRDSRegionsResponse struct {
ResponseMetadata ResponseMetadata `json:"ResponseMetadata"`
Result struct {
Regions []RDSRegion `json:"Regions"`
} `json:"Result"`
}
type DescribeRDSSQLServerInstancesResponse ¶ added in v0.2.5
type DescribeRDSSQLServerInstancesResponse struct {
ResponseMetadata ResponseMetadata `json:"ResponseMetadata"`
Result struct {
InstancesInfo []RDSSQLServerInstance `json:"InstancesInfo"`
Total int32 `json:"Total"`
} `json:"Result"`
}
type DescribeRegionsResponse ¶
type DescribeRegionsResponse struct {
ResponseMetadata ResponseMetadata `json:"ResponseMetadata"`
Result struct {
NextToken string `json:"NextToken"`
Regions []ECSRegion `json:"Regions"`
} `json:"Result"`
}
type DetachUserPolicyResponse ¶ added in v0.2.4
type DetachUserPolicyResponse struct {
ResponseMetadata ResponseMetadata `json:"ResponseMetadata"`
}
type ECSCloudAssistantInstance ¶ added in v0.2.4
type ECSCloudAssistantInstance struct {
ClientVersion string `json:"ClientVersion"`
HostName string `json:"HostName"`
InstanceID string `json:"InstanceId"`
InstanceName string `json:"InstanceName"`
LastHeartbeatTime string `json:"LastHeartbeatTime"`
OSType string `json:"OsType"`
OSVersion string `json:"OsVersion"`
Status string `json:"Status"`
}
type ECSEipAddress ¶
type ECSEipAddress struct {
IPAddress string `json:"IpAddress"`
}
type ECSInstance ¶
type ECSInstance struct {
InstanceID string `json:"InstanceId"`
Hostname string `json:"Hostname"`
Status string `json:"Status"`
OSType string `json:"OsType"`
EipAddress ECSEipAddress `json:"EipAddress"`
NetworkInterfaces []ECSNetworkInterface `json:"NetworkInterfaces"`
}
type ECSInvocationResult ¶ added in v0.2.4
type ECSInvocationResult struct {
CommandID string `json:"CommandId"`
InvocationID string `json:"InvocationId"`
InstanceID string `json:"InstanceId"`
InvocationStatus string `json:"InvocationStatus"`
InvocationResultStatus string `json:"InvocationResultStatus"`
Output string `json:"Output"`
ErrorInfo string `json:"ErrorInfo"`
ErrorMessage string `json:"ErrorMessage"`
ErrorCode string `json:"ErrorCode"`
}
func (ECSInvocationResult) Message ¶ added in v0.2.4
func (r ECSInvocationResult) Message() string
func (ECSInvocationResult) Status ¶ added in v0.2.4
func (r ECSInvocationResult) Status() string
type ECSNetworkInterface ¶
type ECSNetworkInterface struct {
PrimaryIPAddress string `json:"PrimaryIpAddress"`
}
type GetLoginProfileResponse ¶
type GetLoginProfileResponse struct {
ResponseMetadata ResponseMetadata `json:"ResponseMetadata"`
Result struct {
LoginProfile IAMLoginProfile `json:"LoginProfile"`
} `json:"Result"`
}
type IAMLoginProfile ¶
type IAMProject ¶
type IAMUserMetadata ¶
type InvokeCommandResponse ¶ added in v0.2.4
type InvokeCommandResponse struct {
ResponseMetadata ResponseMetadata `json:"ResponseMetadata"`
Result struct {
InvocationID string `json:"InvocationId"`
} `json:"Result"`
}
type ListDNSRecordsResponse ¶ added in v0.2.5
type ListDNSZonesResponse ¶ added in v0.2.5
type ListProjectsResponse ¶
type ListProjectsResponse struct {
ResponseMetadata ResponseMetadata `json:"ResponseMetadata"`
Result struct {
Projects []IAMProject `json:"Projects"`
Total int32 `json:"Total"`
} `json:"Result"`
}
type ListUsersResponse ¶
type ListUsersResponse struct {
ResponseMetadata ResponseMetadata `json:"ResponseMetadata"`
Result struct {
UserMetadata []IAMUserMetadata `json:"UserMetadata"`
Total int32 `json:"Total"`
Limit int32 `json:"Limit"`
Offset int32 `json:"Offset"`
} `json:"Result"`
}
type Option ¶
type Option func(*Client)
func WithBaseURL ¶
func WithHTTPClient ¶
func WithRetryPolicy ¶
func WithRetryPolicy(p RetryPolicy) Option
func WithSiteStack ¶
type QueryBalanceAcctResponse ¶
type QueryBalanceAcctResponse struct {
ResponseMetadata ResponseMetadata `json:"ResponseMetadata"`
Result struct {
AvailableBalance string `json:"AvailableBalance"`
} `json:"Result"`
}
type RDSAddressObject ¶ added in v0.2.5
type RDSMySQLInstance ¶ added in v0.2.5
type RDSPostgreSQLInstance ¶ added in v0.2.5
type RDSPostgreSQLInstance struct {
AddressObject []RDSAddressObject `json:"AddressObject"`
DBEngineVersion string `json:"DBEngineVersion"`
InstanceID string `json:"InstanceId"`
InstanceName string `json:"InstanceName"`
InstanceStatus string `json:"InstanceStatus"`
RegionID string `json:"RegionId"`
}
type RDSSQLServerInstance ¶ added in v0.2.5
type RDSSQLServerInstance struct {
DBEngineVersion string `json:"DBEngineVersion"`
InstanceID string `json:"InstanceId"`
InstanceName string `json:"InstanceName"`
InstanceStatus string `json:"InstanceStatus"`
NodeDetailInfo []RDSSQLServerNode `json:"NodeDetailInfo"`
Port string `json:"Port"`
RegionID string `json:"RegionId"`
}
type RDSSQLServerNode ¶ added in v0.2.5
type ResponseMetadata ¶
type RetryPolicy ¶
type RetryPolicy struct {
MaxAttempts int
BaseDelay time.Duration
MaxDelay time.Duration
Sleep func(context.Context, time.Duration) error
}
func DefaultRetryPolicy ¶
func DefaultRetryPolicy() RetryPolicy
Click to show internal directories.
Click to hide internal directories.