\AlibabaCloud\Client\ClientsEcsRamRoleClient

Use the RAM role of an ECS instance to complete the authentication.

Summary

Methods
Properties
Constants
__construct()
getCredential()
getSignature()
timeout()
timeoutMilliseconds()
connectTimeout()
connectTimeoutMilliseconds()
debug()
cert()
proxy()
verify()
options()
regionId()
getSessionCredential()
asGlobalClient()
asDefaultClient()
name()
isDebug()
$options
$regionId
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$credential
$signature
N/A

Properties

$options

$options : array

Type

array

$regionId

$regionId : string|null

Type

string|null

$credential

$credential : \AlibabaCloud\Client\Credentials\CredentialsInterface|\AlibabaCloud\Client\Credentials\AccessKeyCredential|\AlibabaCloud\Client\Credentials\BearerTokenCredential|\AlibabaCloud\Client\Credentials\StsCredential|\AlibabaCloud\Client\Credentials\EcsRamRoleCredential|\AlibabaCloud\Client\Credentials\RamRoleArnCredential|\AlibabaCloud\Client\Credentials\RsaKeyPairCredential

Type

\AlibabaCloud\Client\Credentials\CredentialsInterface|\AlibabaCloud\Client\Credentials\AccessKeyCredential|\AlibabaCloud\Client\Credentials\BearerTokenCredential|\AlibabaCloud\Client\Credentials\StsCredential|\AlibabaCloud\Client\Credentials\EcsRamRoleCredential|\AlibabaCloud\Client\Credentials\RamRoleArnCredential|\AlibabaCloud\Client\Credentials\RsaKeyPairCredential

Methods

__construct()

__construct(string  $roleName) 

Self constructor.

Parameters

string $roleName

Throws

\AlibabaCloud\Client\Exception\ClientException

getCredential()

getCredential() : \AlibabaCloud\Client\Credentials\AccessKeyCredential|\AlibabaCloud\Client\Credentials\BearerTokenCredential|\AlibabaCloud\Client\Credentials\CredentialsInterface|\AlibabaCloud\Client\Credentials\EcsRamRoleCredential|\AlibabaCloud\Client\Credentials\RamRoleArnCredential|\AlibabaCloud\Client\Credentials\RsaKeyPairCredential|\AlibabaCloud\Client\Credentials\StsCredential

Returns

\AlibabaCloud\Client\Credentials\AccessKeyCredential|\AlibabaCloud\Client\Credentials\BearerTokenCredential|\AlibabaCloud\Client\Credentials\CredentialsInterface|\AlibabaCloud\Client\Credentials\EcsRamRoleCredential|\AlibabaCloud\Client\Credentials\RamRoleArnCredential|\AlibabaCloud\Client\Credentials\RsaKeyPairCredential|\AlibabaCloud\Client\Credentials\StsCredential

getSignature()

getSignature() : \AlibabaCloud\Client\Signature\SignatureInterface|\AlibabaCloud\Client\Signature\BearerTokenSignature|\AlibabaCloud\Client\Signature\ShaHmac1Signature|\AlibabaCloud\Client\Signature\ShaHmac256Signature|\AlibabaCloud\Client\Signature\ShaHmac256WithRsaSignature

Returns

\AlibabaCloud\Client\Signature\SignatureInterface|\AlibabaCloud\Client\Signature\BearerTokenSignature|\AlibabaCloud\Client\Signature\ShaHmac1Signature|\AlibabaCloud\Client\Signature\ShaHmac256Signature|\AlibabaCloud\Client\Signature\ShaHmac256WithRsaSignature

timeout()

timeout(integer|float  $seconds) : $this

Parameters

integer|float $seconds

Throws

\AlibabaCloud\Client\Exception\ClientException

Returns

$this

timeoutMilliseconds()

timeoutMilliseconds(integer  $milliseconds) : $this

Parameters

integer $milliseconds

Throws

\AlibabaCloud\Client\Exception\ClientException

Returns

$this

connectTimeout()

connectTimeout(integer|float  $seconds) : $this

Parameters

integer|float $seconds

Throws

\AlibabaCloud\Client\Exception\ClientException

Returns

$this

connectTimeoutMilliseconds()

connectTimeoutMilliseconds(integer  $milliseconds) : $this

Parameters

integer $milliseconds

Throws

\AlibabaCloud\Client\Exception\ClientException

Returns

$this

debug()

debug(boolean  $debug) : $this

Parameters

boolean $debug

Returns

$this

cert()

cert(array  $cert) : $this

Parameters

array $cert

Returns

$this

proxy()

proxy(array|string  $proxy) : $this

Parameters

array|string $proxy

Returns

$this

verify()

verify(mixed  $verify) : $this

Parameters

mixed $verify

Returns

$this

options()

options(array  $options) : $this

Parameters

array $options

Returns

$this

regionId()

regionId(string  $regionId) : $this

Parameters

string $regionId

Throws

\AlibabaCloud\Client\Exception\ClientException

Returns

$this

getSessionCredential()

getSessionCredential(integer  $timeout = \AlibabaCloud\Client\Request\Request::TIMEOUT, integer  $connectTimeout = \AlibabaCloud\Client\Request\Request::CONNECT_TIMEOUT) : \AlibabaCloud\Client\Credentials\CredentialsInterface|\AlibabaCloud\Client\Credentials\StsCredential

Parameters

integer $timeout
integer $connectTimeout

Throws

\AlibabaCloud\Client\Exception\ClientException
\AlibabaCloud\Client\Exception\ServerException

Returns

\AlibabaCloud\Client\Credentials\CredentialsInterface|\AlibabaCloud\Client\Credentials\StsCredential

asGlobalClient()

asGlobalClient() : static

Throws

\AlibabaCloud\Client\Exception\ClientException

Returns

static

asDefaultClient()

asDefaultClient() : static

Set the current client as the default client.

Throws

\AlibabaCloud\Client\Exception\ClientException

Returns

static

name()

name(string  $name) : static

Naming clients.

Parameters

string $name

Throws

\AlibabaCloud\Client\Exception\ClientException

Returns

static

isDebug()

isDebug() : boolean

Returns

boolean