LOG_PHP_SDK
Back to top  

Aliyun_Log_Client

Aliyun_Log_Client class is the main class in the SDK. It can be used to communicate with LOG server to put/get data.

author

log_dev
package

LOG_PHP_SDK

Methods

Aliyun_Log_Client constructor

__construct(string $endpoint, string $accessKeyId, string $accessKey,  $token = "")

Arguments

$endpoint

string

LOG host name, for example, http://cn-hangzhou.sls.aliyuncs.com

$accessKeyId

string

aliyun accessKeyId

$accessKey

string

aliyun accessKey

$token

applyConfigToMachineGroup

applyConfigToMachineGroup(\Aliyun_Log_Models_ApplyConfigToMachineGroupRequest $request)

Arguments

$request

\Aliyun_Log_Models_ApplyConfigToMachineGroupRequest

Get logs from Log service with shardid conditions.

batchGetLogs(\Aliyun_Log_Models_BatchGetLogsRequest $request) : \Aliyun_Log_Models_BatchGetLogsResponse

Unsuccessful opertaion will cause an Aliyun_Log_Exception.

throws

Arguments

$request

\Aliyun_Log_Models_BatchGetLogsRequest

the BatchGetLogs request parameters class.

Response

\Aliyun_Log_Models_BatchGetLogsResponse

createACL

createACL(\Aliyun_Log_Models_CreateACLRequest $request)

Arguments

$request

\Aliyun_Log_Models_CreateACLRequest

createConfig

createConfig(\Aliyun_Log_Models_CreateConfigRequest $request)

Arguments

$request

\Aliyun_Log_Models_CreateConfigRequest

create logstore Unsuccessful opertaion will cause an Aliyun_Log_Exception.

createLogstore(\Aliyun_Log_Models_CreateLogstoreRequest $request)
throws

return Aliyun_Log_Models_CreateLogstoreResponse

Arguments

$request

\Aliyun_Log_Models_CreateLogstoreRequest

the CreateLogStore request parameters class.

createMachineGroup

createMachineGroup(\Aliyun_Log_Models_CreateMachineGroupRequest $request)

Arguments

$request

\Aliyun_Log_Models_CreateMachineGroupRequest

deleteACL

deleteACL(\Aliyun_Log_Models_DeleteACLRequest $request)

Arguments

$request

\Aliyun_Log_Models_DeleteACLRequest

deleteConfig

deleteConfig(\Aliyun_Log_Models_DeleteConfigRequest $request)

Arguments

$request

\Aliyun_Log_Models_DeleteConfigRequest

Delete logstore Unsuccessful opertaion will cause an Aliyun_Log_Exception.

deleteLogstore(\Aliyun_Log_Models_DeleteLogstoreRequest $request) : \Aliyun_Log_Models_DeleteLogstoresResponse
throws

Arguments

$request

\Aliyun_Log_Models_DeleteLogstoreRequest

the DeleteLogstores request parameters class.

Response

\Aliyun_Log_Models_DeleteLogstoresResponse

deleteMachineGroup

deleteMachineGroup(\Aliyun_Log_Models_DeleteMachineGroupRequest $request)

Arguments

$request

\Aliyun_Log_Models_DeleteMachineGroupRequest

delete a read only shard with Project and logstore and shardId conditions.

DeleteShard(\Aliyun_Log_Models_DeleteShardRequest $request) : \Aliyun_Log_Models_ListShardsResponse

Unsuccessful opertaion will cause an Aliyun_Log_Exception.

throws

Arguments

$request

\Aliyun_Log_Models_DeleteShardRequest

the DeleteShard request parameters class.

Response

\Aliyun_Log_Models_ListShardsResponse

getACL

getACL(\Aliyun_Log_Models_GetACLRequest $request)

Arguments

$request

\Aliyun_Log_Models_GetACLRequest

getConfig

getConfig(\Aliyun_Log_Models_GetConfigRequest $request)

Arguments

$request

\Aliyun_Log_Models_GetConfigRequest

Get cursor from Log service.

getCursor(\Aliyun_Log_Models_GetCursorRequest $request) : \Aliyun_Log_Models_GetCursorResponse

Unsuccessful opertaion will cause an Aliyun_Log_Exception.

throws

Arguments

$request

\Aliyun_Log_Models_GetCursorRequest

the GetCursor request parameters class.

Response

\Aliyun_Log_Models_GetCursorResponse

GMT format time string.

getGMT() : string

Response

string

Get histograms of requested query from log service.

getHistograms(\Aliyun_Log_Models_GetHistogramsRequest $request) : \Aliyun_Log_Models_GetHistogramsResponse

Unsuccessful opertaion will cause an Aliyun_Log_Exception.

throws

Arguments

$request

\Aliyun_Log_Models_GetHistogramsRequest

the GetHistograms request parameters class.

Response

\Aliyun_Log_Models_GetHistogramsResponse

getHttpResponse

getHttpResponse( $method,  $url,  $body,  $headers) : array

Arguments

$method

$url

$body

$headers

Response

array

Get logs from Log service.

getLogs(\Aliyun_Log_Models_GetLogsRequest $request) : \Aliyun_Log_Models_GetLogsResponse

Unsuccessful opertaion will cause an Aliyun_Log_Exception.

throws

Arguments

$request

\Aliyun_Log_Models_GetLogsRequest

the GetLogs request parameters class.

Response

\Aliyun_Log_Models_GetLogsResponse

getMachine

getMachine(\Aliyun_Log_Models_GetMachineRequest $request)

Arguments

$request

\Aliyun_Log_Models_GetMachineRequest

getMachineGroup

getMachineGroup(\Aliyun_Log_Models_GetMachineGroupRequest $request)

Arguments

$request

\Aliyun_Log_Models_GetMachineGroupRequest

listACLs

listACLs(\Aliyun_Log_Models_ListACLsRequest $request)

Arguments

$request

\Aliyun_Log_Models_ListACLsRequest

listConfigs

listConfigs(\Aliyun_Log_Models_ListConfigsRequest $request)

Arguments

$request

\Aliyun_Log_Models_ListConfigsRequest

List all logstores of requested project.

listLogstores(\Aliyun_Log_Models_ListLogstoresRequest $request) : \Aliyun_Log_Models_ListLogstoresResponse

Unsuccessful opertaion will cause an Aliyun_Log_Exception.

throws

Arguments

$request

\Aliyun_Log_Models_ListLogstoresRequest

the ListLogstores request parameters class.

Response

\Aliyun_Log_Models_ListLogstoresResponse

listMachineGroups

listMachineGroups(\Aliyun_Log_Models_ListMachineGroupsRequest $request)

Arguments

$request

\Aliyun_Log_Models_ListMachineGroupsRequest

List Shards from Log service with Project and logstore conditions.

listShards(\Aliyun_Log_Models_ListShardsRequest $request) : \Aliyun_Log_Models_ListShardsResponse

Unsuccessful opertaion will cause an Aliyun_Log_Exception.

throws

Arguments

$request

\Aliyun_Log_Models_ListShardsRequest

the ListShards request parameters class.

Response

\Aliyun_Log_Models_ListShardsResponse

List all topics in a logstore.

listTopics(\Aliyun_Log_Models_ListTopicsRequest $request) : \Aliyun_Log_Models_ListTopicsResponse

Unsuccessful opertaion will cause an Aliyun_Log_Exception.

throws

Arguments

$request

\Aliyun_Log_Models_ListTopicsRequest

the ListTopics request parameters class.

Response

\Aliyun_Log_Models_ListTopicsResponse

merge two shards into one shard with Project and logstore and shardId and conditions.

MergeShards(\Aliyun_Log_Models_MergeShardsRequest $request) : \Aliyun_Log_Models_ListShardsResponse

Unsuccessful opertaion will cause an Aliyun_Log_Exception.

throws

Arguments

$request

\Aliyun_Log_Models_MergeShardsRequest

the MergeShards request parameters class.

Response

\Aliyun_Log_Models_ListShardsResponse

Decodes a JSON string to a JSON Object.

parseToJson( $resBody,  $requestId) : string

Unsuccessful decode will cause an Aliyun_Log_Exception.

throws

Arguments

$resBody

$requestId

Response

string

Put logs to Log Service.

putLogs(\Aliyun_Log_Models_PutLogsRequest $request) : \Aliyun_Log_Models_PutLogsResponse

Unsuccessful opertaion will cause an Aliyun_Log_Exception.

throws

Arguments

$request

\Aliyun_Log_Models_PutLogsRequest

the PutLogs request parameters class

Response

\Aliyun_Log_Models_PutLogsResponse

removeConfigFromMachineGroup

removeConfigFromMachineGroup(\Aliyun_Log_Models_RemoveConfigFromMachineGroupRequest $request)

Arguments

$request

\Aliyun_Log_Models_RemoveConfigFromMachineGroupRequest

send

send( $method,  $project,  $body,  $resource,  $params,  $headers) : array
throws

Arguments

$method

$project

$body

$resource

$params

$headers

Response

array

sendRequest

sendRequest( $method,  $url,  $body,  $headers) : array
throws

Arguments

$method

$url

$body

$headers

Response

array

setEndpoint

setEndpoint( $endpoint)

Arguments

$endpoint

split a shard into two shards with Project and logstore and shardId and midHash conditions.

splitShard(\Aliyun_Log_Models_SplitShardRequest $request) : \Aliyun_Log_Models_ListShardsResponse

Unsuccessful opertaion will cause an Aliyun_Log_Exception.

throws

Arguments

$request

\Aliyun_Log_Models_SplitShardRequest

the SplitShard request parameters class.

Response

\Aliyun_Log_Models_ListShardsResponse

updateACL

updateACL(\Aliyun_Log_Models_UpdateACLRequest $request)

Arguments

$request

\Aliyun_Log_Models_UpdateACLRequest

updateConfig

updateConfig(\Aliyun_Log_Models_UpdateConfigRequest $request)

Arguments

$request

\Aliyun_Log_Models_UpdateConfigRequest

update logstore Unsuccessful opertaion will cause an Aliyun_Log_Exception.

updateLogstore(\Aliyun_Log_Models_UpdateLogstoreRequest $request)
throws

return Aliyun_Log_Models_UpdateLogstoreResponse

Arguments

$request

\Aliyun_Log_Models_UpdateLogstoreRequest

the UpdateLogStore request parameters class.

updateMachineGroup

updateMachineGroup(\Aliyun_Log_Models_UpdateMachineGroupRequest $request)

Arguments

$request

\Aliyun_Log_Models_UpdateMachineGroupRequest

Properties

aliyun accessKey

accessKey : string
var

aliyun accessKey

Type(s)

string

aliyun accessKeyId

accessKeyId : string
var

aliyun accessKeyId

Type(s)

string

aliyun sts token

stsToken : string
var

aliyun sts token

Type(s)

string

LOG endpoint

endpoint : string
var

LOG endpoint

Type(s)

string

Check if the host if row ip.

isRowIp : string
var

Check if the host if row ip.

Type(s)

string

Http send port. The dafault value is 80.

port : integer
var

Http send port. The dafault value is 80.

Type(s)

integer

log sever host.

logHost : string
var

log sever host.

Type(s)

string

the local machine ip address.

source : string
var

the local machine ip address.

Type(s)

string