1. Docs
  2. Reference
  3. API
  4. @pulumi/alicloud
  5. types
  6. output

Module types/output

This page documents the language specification for the alicloud package. If you're looking for help working with the inputs, outputs, or functions of alicloud resources in a Pulumi program, please see the resource documentation for examples and API reference.

namespace actiontrail

namespace adb

namespace apigateway

namespace cas

namespace cdn

namespace cen

namespace cloudconnect

namespace cms

namespace cr

namespace cs

namespace ddos

namespace dds

namespace dns

namespace drds

namespace ecs

namespace edas

namespace elasticsearch

namespace emr

namespace ess

namespace fc

namespace gpdb

namespace hbase

namespace kms

namespace kvstore

namespace log

namespace marketplace

namespace mns

namespace mongodb

namespace nas

namespace oss

namespace ots

namespace polardb

namespace pvtz

namespace ram

namespace rds

namespace resourcemanager

namespace rocketmq

namespace sag

namespace slb

namespace vpc

namespace vpn

namespace waf

namespace yundun

APIs

namespace actiontrail

interface GetInstancesInstance

interface GetInstancesInstance

property createTime

createTime: string;

The create time of the instance.

property deployType

deployType: number;

The deploy type of the instance. 0: sharing instance, 1: vpc instance, 2: vpc instance(support ip mapping), 3: eip instance, 4: eip/vpc instance, 5: vpc instance.

property diskSize

diskSize: number;

The disk size of the instance.

property diskType

diskType: number;

The disk type of the instance. 0: efficient cloud disk , 1: SSD.

property eipMax

eipMax: number;

The peak bandwidth of the instance.

property id

id: string;

ID of the instance.

property ioMax

ioMax: number;

The peak value of io of the instance.

property name

name: string;

Name of the instance.

property paidType

paidType: string;

The paid type of the instance.

property serviceStatus

serviceStatus: number;

The current status of the instance. -1: unknown status, 0: wait deploy, 1: initializing, 2: preparing, 3 starting, 5: in service, 7: wait upgrade, 8: upgrading, 10: released, 15: freeze, 101: deploy error, 102: upgrade error.

property specType

specType: string;

The spec type of the instance.

property topicQuota

topicQuota: number;

The max num of topic can be create of the instance.

property vpcId

vpcId: string;

The ID of attaching VPC to instance.

property vswitchId

vswitchId: string;

The ID of attaching vswitch to instance.

property zoneId

zoneId: string;

The ID of attaching zone to instance.

interface GetSaslAclsAcl

interface GetSaslAclsAcl

property aclOperationType

aclOperationType: string;

The operation type of the sasl acl.

property aclResourceName

aclResourceName: string;

Get results for the specified resource name.

property aclResourcePatternType

aclResourcePatternType: string;

The resource pattern type of the sasl acl.

property aclResourceType

aclResourceType: string;

Get results for the specified resource type.

property host

host: string;

The host of the sasl acl.

property username

username: string;

Get results for the specified username.

interface GetSaslUsersUser

interface GetSaslUsersUser

property password

password: string;

The password of the user.

property username

username: string;

The username of the user.

interface GetTopicsTopic

interface GetTopicsTopic

property compactTopic

compactTopic: boolean;

whether the current topic is kafka compact topic or not.

property createTime

createTime: string;

Time of creation.

property localTopic

localTopic: boolean;

whether the current topic is kafka local topic or not.

property partitionNum

partitionNum: number;

Partition number of the topic.

property remark

remark: string;

Remark of the topic.

property status

status: number;

The current status code of the topic. There are three values to describe the topic status: 0 stands for the topic is in service, 1 stands for freezing and 2 stands for pause.

property topic

topic: string;

The name of the topic.

interface GetTrailsActiontrail

interface GetTrailsActiontrail

property eventRw

eventRw: string;

Indicates whether the event is a read or a write event.

property name

name: string;

The name of the trail.

property ossBucketName

ossBucketName: string;

The name of the specified OSS bucket.

property ossKeyPrefix

ossKeyPrefix: string;

The prefix of the specified OSS bucket name.

property roleName

roleName: string;

The role in ActionTrail.

property slsProjectArn

slsProjectArn: string;

The unique ARN of the Log Service project.

property slsWriteRoleArn

slsWriteRoleArn: string;

The unique ARN of the Log Service role.

namespace adb

interface GetClustersCluster

interface GetClustersCluster

property chargeType

chargeType: string;

Billing method. Value options: PostPaid for Pay-As-You-Go and PrePaid for subscription.

property createTime

createTime: string;

The CreateTime of the ADB cluster.

property dbNodeClass

dbNodeClass: string;

The DBNodeClass of the ADB cluster.

property dbNodeCount

dbNodeCount: number;

The DBNodeCount of the ADB cluster.

property dbNodeStorage

dbNodeStorage: number;

The DBNodeStorage of the ADB cluster.

property description

description: string;

The description of the ADB cluster.

property expireTime

expireTime: string;

Expiration time. Pay-As-You-Go clusters never expire.

property expired

expired: string;

The expired of the ADB cluster.

property id

id: string;

The ID of the ADB cluster.

property lockMode

lockMode: string;

The LockMode of the ADB cluster.

property networkType

networkType: string;

The DBClusterNetworkType of the ADB cluster.

property regionId

regionId: string;

Region ID the cluster belongs to.

property status

status: string;

Status of the cluster.

property vpcId

vpcId: string;

ID of the VPC the cluster belongs to.

property zoneId

zoneId: string;

The ZoneId of the ADB cluster.

interface GetZonesZone

interface GetZonesZone

property id

id: string;

ID of the zone.

property multiZoneIds

multiZoneIds: string[];

A list of zone ids in which the multi zone.

namespace apigateway

interface ApiConstantParameter

interface ApiConstantParameter

property description

description?: undefined | string;

The description of Constant parameter.

property in

in: string;

System parameter location; values: ‘HEAD’ and ‘QUERY’.

property name

name: string;

System parameter name which supports values including in system parameter list

property value

value: string;

Constant parameter value.

interface ApiFcServiceConfig

interface ApiFcServiceConfig

property arnRole

arnRole?: undefined | string;

RAM role arn attached to the Function Compute service. This governs both who / what can invoke your Function, as well as what resources our Function has access to. See User Permissions for more details.

property functionName

functionName: string;

The function name of function compute service.

property region

region: string;

The region that the function compute service belongs to.

property serviceName

serviceName: string;

The service name of function compute service.

property timeout

timeout: number;

Backend service time-out time; unit: millisecond.

interface ApiHttpServiceConfig

interface ApiHttpServiceConfig

property address

address: string;

The address of backend service.

property aoneName

aoneName?: undefined | string;

property method

method: string;

The http method of backend service.

property path

path: string;

The path of backend service.

property timeout

timeout: number;

Backend service time-out time; unit: millisecond.

interface ApiHttpVpcServiceConfig

interface ApiHttpVpcServiceConfig

property aoneName

aoneName?: undefined | string;

property method

method: string;

The http method of backend service.

property name

name: string;

System parameter name which supports values including in system parameter list

property path

path: string;

The path of backend service.

property timeout

timeout: number;

Backend service time-out time; unit: millisecond.

interface ApiMockServiceConfig

interface ApiMockServiceConfig

property aoneName

aoneName?: undefined | string;

property result

result: string;

The result of the mock service.

interface ApiRequestConfig

interface ApiRequestConfig

property bodyFormat

bodyFormat?: undefined | string;

The body format of the api, which support the values of ‘STREAM’ and ‘FORM’

property method

method: string;

The http method of backend service.

property mode

mode: string;

The mode of the parameters between request parameters and service parameters, which support the values of ‘MAPPING’ and ‘PASSTHROUGH’

property path

path: string;

The path of backend service.

property protocol

protocol: string;

The protocol of api which supports values of ‘HTTP’,‘HTTPS’ or ‘HTTP,HTTPS’

interface ApiRequestParameter

interface ApiRequestParameter

property defaultValue

defaultValue?: undefined | string;

The default value of the parameter.

property description

description?: undefined | string;

The description of Constant parameter.

property in

in: string;

System parameter location; values: ‘HEAD’ and ‘QUERY’.

property inService

inService: string;

Backend service’s parameter location; values: BODY, HEAD, QUERY, and PATH.

property name

name: string;

System parameter name which supports values including in system parameter list

property nameService

nameService: string;

Backend service’s parameter name.

property required

required: string;

Parameter required or not; values: REQUIRED and OPTIONAL.

property type

type: string;

Parameter type which supports values of ‘STRING’,‘INT’,‘BOOLEAN’,‘LONG’,“FLOAT” and “DOUBLE”

interface ApiSystemParameter

interface ApiSystemParameter

property in

in: string;

System parameter location; values: ‘HEAD’ and ‘QUERY’.

property name

name: string;

System parameter name which supports values including in system parameter list

property nameService

nameService: string;

Backend service’s parameter name.

interface GetApisApi

interface GetApisApi

property description

description: string;

API description.

property groupId

groupId: string;

ID of the specified group.

property groupName

groupName: string;

The group name that the apis belong to.

property id

id: string;

API ID, which is generated by the system and globally unique.

property name

name: string;

API name.

property regionId

regionId: string;

The ID of the region where the API is located.

interface GetAppsApp

interface GetAppsApp

property appCode

appCode: string;

App code.

property createdTime

createdTime: string;

Creation time (Greenwich mean time).

property description

description: string;

App description.

property id

id: number;

App ID, which is generated by the system and globally unique.

property modifiedTime

modifiedTime: string;

Last modification time (Greenwich mean time).

property name

name: string;

App name.

interface GetGroupsGroup

interface GetGroupsGroup

property billingStatus

billingStatus: string;

Billing status. - NORMAL: The API group is normal. - LOCKED: Locked due to outstanding payment.

property createdTime

createdTime: string;

Creation time (Greenwich mean time).

property description

description: string;

API group description.

property id

id: string;

API group ID, which is generated by the system and globally unique.

property illegalStatus

illegalStatus: string;

Locking in invalid state. - NORMAL: The API group is normal. - LOCKED: Locked due to illegality.

property modifiedTime

modifiedTime: string;

Last modification time (Greenwich mean time).

property name

name: string;

API group name.

property regionId

regionId: string;

The ID of the region where the API group is located.

property subDomain

subDomain: string;

Second-level domain name automatically assigned to the API group.

property trafficLimit

trafficLimit: number;

Upper QPS limit of the API group; default value: 500, which can be increased by submitting an application.

namespace cas

interface GetCertificatesCertificate

interface GetCertificatesCertificate

property buyInAliyun

buyInAliyun: boolean;

The cert is buy from aliyun or not.

property city

city: string;

The cert’s city.

property common

common: string;

The cert’s common name.

property country

country: string;

The cert’s country.

property endDate

endDate: string;

The cert’s not valid after time.

property expired

expired: boolean;

The cert is expired or not.

property fingerPrint

fingerPrint: string;

The cert’s finger.

property id

id: number;

The cert’s id.

property issuer

issuer: string;

The cert’s .

property name

name: string;

The cert’s name.

property orgName

orgName: string;

The cert’s organization.

property province

province: string;

The cert’s province.

property sans

sans: string;

The cert’s subject alternative name.

property startDate

startDate: string;

The cert’s not valid before time.

namespace cdn

interface DomainAuthConfig

interface DomainAuthConfig

property authType

authType?: undefined | string;

Auth type of the auth config. Valid values are noAuth, typeA, typeB and typeC. Default value is noAuth.

property masterKey

masterKey: string;

Master authentication key of the auth config. This parameter can have a string of 6 to 32 characters and must contain only alphanumeric characters.

property slaveKey

slaveKey: string;

Slave authentication key of the auth config. This parameter can have a string of 6 to 32 characters and must contain only alphanumeric characters.

property timeout

timeout?: undefined | number;

Authentication cache time of the auth config. Default value is 1800. It’s value is valid only when the authType is typeB or typeC.

interface DomainCacheConfig

interface DomainCacheConfig

property cacheContent

cacheContent: string;

Cache content of the cache config. It’s value is a path string when the cacheType is path. When the cacheType is suffix, it’s value is a string which contains multiple file suffixes separated by commas.

property cacheId

cacheId: string;

property cacheType

cacheType: string;

Cache type of the cache config. Valid values are suffix and path.

property ttl

ttl: number;

Cache time of the cache config.

property weight

weight?: undefined | number;

Weight of the cache config. This parameter’s value is between 1 and 99. Default value is 1. The higher the value, the higher the priority.

interface DomainCertificateConfig

interface DomainCertificateConfig

property privateKey

privateKey?: undefined | string;

The SSL private key. This is required if serverCertificateStatus is on

property serverCertificate

serverCertificate?: undefined | string;

The SSL server certificate string. This is required if serverCertificateStatus is on

property serverCertificateStatus

serverCertificateStatus?: undefined | string;

This parameter indicates whether or not enable https. Valid values are on and off. Default value is on.

interface DomainConfigFunctionArg

interface DomainConfigFunctionArg

property argName

argName: string;

The name of arg.

property argValue

argValue: string;

The value of arg.

interface DomainHttpHeaderConfig

interface DomainHttpHeaderConfig

property headerId

headerId: string;

property headerKey

headerKey: string;

Header key of the http header. Valid values are Content-Type, Cache-Control, Content-Disposition, Content-Language，Expires, Access-Control-Allow-Origin, Access-Control-Allow-Methods and Access-Control-Max-Age.

property headerValue

headerValue: string;

Header value of the http header.

interface DomainNewCertificateConfig

interface DomainNewCertificateConfig

property certName

certName?: undefined | string;

The SSL certificate name.

property certType

certType?: undefined | string;

The SSL certificate type, can be “upload”, “cas” and “free”.

property forceSet

forceSet?: undefined | string;

Set 1 to ignore the repeated verification for certificate name, and cover the information of the origin certificate (with the same name). Set 0 to work the verification.

property privateKey

privateKey?: undefined | string;

The SSL private key. This is required if serverCertificateStatus is on

property serverCertificate

serverCertificate?: undefined | string;

The SSL server certificate string. This is required if serverCertificateStatus is on

property serverCertificateStatus

serverCertificateStatus?: undefined | string;

This parameter indicates whether or not enable https. Valid values are on and off. Default value is on.

interface DomainNewSources

interface DomainNewSources

property content

content: string;

The adress of source. Valid values can be ip or doaminName. Each item’s content can not be repeated.

property port

port?: undefined | number;

The port of source. Valid values are 443 and 80. Default value is 80.

property priority

priority?: undefined | number;

Priority of the source. Valid values are 0 and 100. Default value is 20.

property type

type: string;

The type of the source. Valid values are ipaddr, domain and oss.

property weight

weight?: undefined | number;

Weight of the source. Valid values are from 0 to 100. Default value is 10, but if type is ipaddr, the value can only be 10.

interface DomainPage404Config

interface DomainPage404Config

property customPageUrl

customPageUrl?: undefined | string;

Custom page url of the error page. It must be the full path under the accelerated domain name. It’s value must be http://promotion.alicdn.com/help/oss/error.html when pageType value is charity and It can not be set when pageType value is default.

property errorCode

errorCode: string;

property pageType

pageType?: undefined | string;

Page type of the error page. Valid values are default, charity, other. Default value is default.

interface DomainParameterFilterConfig

interface DomainParameterFilterConfig

property enable

enable?: undefined | string;

This parameter indicates whether or not the parameterFilterConfig is enable. Valid values are on and off. Default value is off.

property hashKeyArgs

hashKeyArgs: string[];

Reserved parameters of parameterFilterConfig. It’s a list of string and consists of at most 10 items.

interface DomainReferConfig

interface DomainReferConfig

property allowEmpty

allowEmpty?: undefined | string;

This parameter indicates whether or not to allow empty refer access. Valid values are on and off. Default value is on.

property referLists

referLists: string[];

A list of domain names of the refer config.

property referType

referType?: undefined | string;

Refer type of the refer config. Valid values are block and allow. Default value is block.

namespace cen

interface GetBandwidthLimitsLimit

interface GetBandwidthLimitsLimit

property bandwidthLimit

bandwidthLimit: number;

The bandwidth limit configured for the interconnected regions communication.

property instanceId

instanceId: string;

ID of the CEN instance.

property localRegionId

localRegionId: string;

ID of local region.

property oppositeRegionId

oppositeRegionId: string;

ID of opposite region.

property status

status: string;

Status of the CEN Bandwidth Limit, including “Active” and “Modifying”.

interface GetBandwidthPackagesPackage

interface GetBandwidthPackagesPackage

property bandwidth

bandwidth: number;

The bandwidth in Mbps of the CEN bandwidth package.

property bandwidthPackageChargeType

bandwidthPackageChargeType: string;

The billing method, including “POSTPAY” and “PREPAY”.

property businessStatus

businessStatus: string;

Status of the CEN Bandwidth Package, including “Normal”, “FinancialLocked” and “SecurityLocked”.

property creationTime

creationTime: string;

Creation time of the CEN bandwidth package.

property description

description: string;

Description of the CEN Bandwidth Package.

property geographicRegionAId

geographicRegionAId: string;

Region ID of the interconnected regions.

property geographicRegionBId

geographicRegionBId: string;

Region ID of the interconnected regions.

property id

id: string;

ID of the CEN Bandwidth Package.

property instanceId

instanceId: string;

ID of a CEN instance.

property name

name: string;

Name of the CEN Bandwidth Package.

property status

status: string;

Status of the CEN Bandwidth Package in CEN instance, including “Idle” and “InUse”.

interface GetFlowlogsFlowlog

interface GetFlowlogsFlowlog

property cenId

cenId: string;

The ID of the CEN Instance.

property description

description: string;

The description of flowlog.

property flowLogId

flowLogId: string;

ID of the CEN flow log.

property flowLogName

flowLogName: string;

The name of flowlog.

property id

id: string;

ID of the CEN flow log.

property logStoreName

logStoreName: string;

The name of the log store which is in the projectName SLS project.

property projectName

projectName: string;

The name of the SLS project.

property status

status: string;

The status of flowlog. Valid values: [“Active”, “Inactive”]. Default to “Active”.

interface GetInstancesInstance

interface GetInstancesInstance

property cenBandwidthPackageIds

cenBandwidthPackageIds: string[];

List of CEN Bandwidth Package IDs in the specified CEN instance.

property cenId

cenId: string;

ID of the CEN instance.

property description

description: string;

Description of the CEN instance.

property id

id: string;

ID of the CEN instance.

property name

name: string;

Name of the CEN instance.

property protectionLevel

protectionLevel: string;

Indicates the allowed level of CIDR block overlapping.

property status

status: string;

Status of the CEN instance, including “Creating”, “Active” and “Deleting”.

property tags

tags: {[key: string]: any};

A mapping of tags to assign to the resource.

interface GetRegionRouteEntriesEntry

interface GetRegionRouteEntriesEntry

property cidrBlock

cidrBlock: string;

The destination CIDR block of the route entry.

property nextHopId

nextHopId: string;

ID of the next hop.

property nextHopRegionId

nextHopRegionId: string;

ID of the region where the next hop is located.

property nextHopType

nextHopType: string;

Type of the next hop.

property type

type: string;

Type of the route entry.

interface GetRouteEntriesEntry

interface GetRouteEntriesEntry

property cidrBlock

cidrBlock: string;

The destination CIDR block of the route entry to query.

property conflicts

conflicts: GetRouteEntriesEntryConflict[];

A list of conflicted Route Entries. Each element contains the following attributes:

property nextHopId

nextHopId: string;

ID of the next hop.

property nextHopType

nextHopType: string;

Type of the next hop, including “Instance”, “HaVip” and “RouterInterface”.

property operationalMode

operationalMode: boolean;

Whether to allow the route entry to be published or removed to or from CEN.

property publishStatus

publishStatus: string;

The publish status of the route entry in CEN, including “Published” and “NonPublished”.

property routeTableId

routeTableId: string;

ID of the route table of the VPC or VBR.

property routeType

routeType: string;

Type of the route entry, including “System”, “Custom” and “BGP”.

interface GetRouteEntriesEntryConflict

interface GetRouteEntriesEntryConflict

property cidrBlock

cidrBlock: string;

The destination CIDR block of the route entry to query.

property instanceId

instanceId: string;

ID of the CEN instance.

property instanceType

instanceType: string;

The type of the CEN child instance.

property regionId

regionId: string;

ID of the region where the conflicted route entry is located.

property status

status: string;

Reasons of exceptions.

namespace cloudconnect

interface GetNetworksNetwork

interface GetNetworksNetwork

property cidrBlock

cidrBlock: string;

CidrBlock of the CCN instance.

property description

description: string;

property id

id: string;

ID of the CCN instance.

property isDefault

isDefault: boolean;

IsDefault of the CCN instance.

property name

name: string;

Name of the CCN instance.

namespace cms

interface SiteMonitorIspCity

interface SiteMonitorIspCity

property city

city: string;

property isp

isp: string;

namespace cr

interface GetNamespacesNamespace

interface GetNamespacesNamespace

property autoCreate

autoCreate: boolean;

Boolean, when it set to true, repositories are automatically created when pushing new images. If it set to false, you create repository for images before pushing.

property defaultVisibility

defaultVisibility: string;

PUBLIC or PRIVATE, default repository visibility in this namespace.

property name

name: string;

Name of Container Registry namespace.

interface GetReposRepo

interface GetReposRepo

property domainList

domainList: GetReposRepoDomainList;

The repository domain list.

property name

name: string;

Name of container registry namespace.

property namespace

namespace: string;

Name of container registry namespace where the repositories are located in.

property repoType

repoType: string;

PUBLIC or PRIVATE, repository’s visibility.

property summary

summary: string;

The repository general information.

property tags

tags: GetReposRepoTag[];

A list of image tags belong to this repository. Each contains several attributes, see Block Tag.

interface GetReposRepoDomainList

interface GetReposRepoDomainList

property internal

internal: string;

Domain of internal endpoint, only in some regions.

property public

public: string;

Domain of public endpoint.

property vpc

vpc: string;

Domain of vpc endpoint.

interface GetReposRepoTag

interface GetReposRepoTag

property digest

digest: string;

Digest of this image.

property imageCreate

imageCreate: number;

Create time of this image, unix time in nanoseconds.

property imageId

imageId: string;

Id of this image.

property imageSize

imageSize: number;

Status of this image, in bytes.

property imageUpdate

imageUpdate: number;

Last update time of this image, unix time in nanoseconds.

property status

status: string;

Status of this image.

property tag

tag: string;

Tag of this image.

interface RepoDomainList

interface RepoDomainList

property internal

internal: string;

Domain of internal endpoint, only in some regions.

property public

public: string;

Domain of public endpoint.

property vpc

vpc: string;

Domain of vpc endpoint.

namespace cs

interface ApplicationService

interface ApplicationService

property id

id: string;

ID of the service.

property name

name: string;

The application name. It should be 1-64 characters long, and can contain numbers, English letters and hyphens, but cannot start with hyphens.

property status

status: string;

The current status of service.

property version

version: string;

The application deploying version. Each updating, it must be different with current. Default to “1.0”

interface ClusterNode

interface ClusterNode

property eip

eip: string;

property id

id: string;

property name

name: string;

property privateIp

privateIp: string;

property status

status: string;

interface GetKubernetesClustersCluster

interface GetKubernetesClustersCluster

property availabilityZone

availabilityZone: string;

The ID of availability zone.

property clusterNetworkType

clusterNetworkType: string;

property connections

connections: GetKubernetesClustersClusterConnections;

Map of kubernetes cluster connection information. It contains several attributes to Block Connections.

property id

id: string;

ID of the node.

property imageId

imageId: string;

The ID of node image.

property keyName

keyName: string;

The keypair of ssh login cluster node, you have to create it first.

property logConfigs

logConfigs: GetKubernetesClustersClusterLogConfig[];

A list of one element containing information about the associated log store. It contains the following attributes:

property masterAutoRenew

masterAutoRenew: boolean;

property masterAutoRenewPeriod

masterAutoRenewPeriod: number;

property masterDiskCategory

masterDiskCategory: string;

The system disk category of master node.

property masterDiskSize

masterDiskSize: number;

The system disk size of master node.

property masterInstanceChargeType

masterInstanceChargeType: string;

property masterInstanceTypes

masterInstanceTypes: string[];

The instance type of master node.

property masterNodes

masterNodes: GetKubernetesClustersClusterMasterNode[];

List of cluster master nodes. It contains several attributes to Block Nodes.

property masterPeriod

masterPeriod: number;

property masterPeriodUnit

masterPeriodUnit: string;

property name

name: string;

Node name.

property natGatewayId

natGatewayId: string;

The ID of nat gateway used to launch kubernetes cluster.

property nodeCidrMask

nodeCidrMask: number;

The network mask used on pods for each node.

property podCidr

podCidr: string;

property securityGroupId

securityGroupId: string;

The ID of security group where the current cluster worker node is located.

property serviceCidr

serviceCidr: string;

property slbInternetEnabled

slbInternetEnabled: boolean;

Whether internet load balancer for API Server is created

property vpcId

vpcId: string;

The ID of VPC where the current cluster is located.

property vswitchIds

vswitchIds: string[];

The ID of VSwitches where the current cluster is located.

property workerAutoRenew

workerAutoRenew: boolean;

property workerAutoRenewPeriod

workerAutoRenewPeriod: number;

property workerDataDiskCategory

workerDataDiskCategory: string;

The data disk size of worker node.

property workerDataDiskSize

workerDataDiskSize: number;

The data disk category of worker node.

property workerDiskCategory

workerDiskCategory: string;

The system disk category of worker node.

property workerDiskSize

workerDiskSize: number;

The system disk size of worker node.

property workerInstanceChargeType

workerInstanceChargeType: string;

property workerInstanceTypes

workerInstanceTypes: string[];

The instance type of worker node.

property workerNodes

workerNodes: GetKubernetesClustersClusterWorkerNode[];

List of cluster worker nodes. It contains several attributes to Block Nodes.

property workerNumbers

workerNumbers: number[];

The ECS instance node number in the current container cluster.

property workerPeriod

workerPeriod: number;

property workerPeriodUnit

workerPeriodUnit: string;

interface GetKubernetesClustersClusterConnections

interface GetKubernetesClustersClusterConnections

property apiServerInternet

apiServerInternet: string;

API Server Internet endpoint.

property apiServerIntranet

apiServerIntranet: string;

API Server Intranet endpoint.

property masterPublicIp

masterPublicIp: string;

Master node SSH IP address.

property serviceDomain

serviceDomain: string;

Service Access Domain.

interface GetKubernetesClustersClusterLogConfig

interface GetKubernetesClustersClusterLogConfig

property project

project: string;

Log Service project name.

property type

type: string;

Type of collecting logs.

interface GetKubernetesClustersClusterMasterNode

interface GetKubernetesClustersClusterMasterNode

property id

id: string;

ID of the node.

property name

name: string;

Node name.

property privateIp

privateIp: string;

The private IP address of node.

interface GetKubernetesClustersClusterWorkerNode

interface GetKubernetesClustersClusterWorkerNode

property id

id: string;

ID of the node.

property name

name: string;

Node name.

property privateIp

privateIp: string;

The private IP address of node.

interface GetManagedKubernetesClustersCluster

interface GetManagedKubernetesClustersCluster

property availabilityZone

availabilityZone: string;

The ID of availability zone.

property connections

connections: GetManagedKubernetesClustersClusterConnections;

Map of kubernetes cluster connection information. It contains several attributes to Block Connections.

property id

id: string;

ID of the node.

property name

name: string;

Node name.

property natGatewayId

natGatewayId: string;

The ID of nat gateway used to launch kubernetes cluster.

property securityGroupId

securityGroupId: string;

The ID of security group where the current cluster worker node is located.

property vpcId

vpcId: string;

The ID of VPC where the current cluster is located.

property workerNodes

workerNodes: GetManagedKubernetesClustersClusterWorkerNode[];

List of cluster worker nodes. It contains several attributes to Block Nodes.

interface GetManagedKubernetesClustersClusterConnections

interface GetManagedKubernetesClustersClusterConnections

property apiServerInternet

apiServerInternet: string;

API Server Internet endpoint.

property apiServerIntranet

apiServerIntranet: string;

API Server Intranet endpoint.

property masterPublicIp

masterPublicIp: string;

Master node SSH IP address.

property serviceDomain

serviceDomain: string;

Service Access Domain.

interface GetManagedKubernetesClustersClusterWorkerNode

interface GetManagedKubernetesClustersClusterWorkerNode

property id

id: string;

ID of the node.

property name

name: string;

Node name.

property privateIp

privateIp: string;

The private IP address of node.

interface GetRegistryEnterpriseInstancesInstance

interface GetRegistryEnterpriseInstancesInstance

property id

id: string;

ID of Container Registry Enterprise Edition instance.

property name

name: string;

Name of Container Registry Enterprise Edition instance.

property namespaceQuota

namespaceQuota: string;

The max number of namespaces that an instance can create.

property namespaceUsage

namespaceUsage: string;

The number of namespaces already created.

property publicEndpoints

publicEndpoints: string[];

A list of domains for access on internet network.

property region

region: string;

Region of Container Registry Enterprise Edition instance.

property repoQuota

repoQuota: string;

The max number of repos that an instance can create.

property repoUsage

repoUsage: string;

The number of repos already created.

property specification

specification: string;

Specification of Container Registry Enterprise Edition instance.

property vpcEndpoints

vpcEndpoints: string[];

A list of domains for access on vpc network.

interface GetRegistryEnterpriseNamespacesNamespace

interface GetRegistryEnterpriseNamespacesNamespace

property autoCreate

autoCreate: boolean;

Boolean, when it set to true, repositories are automatically created when pushing new images. If it set to false, you create repository for images before pushing.

property defaultVisibility

defaultVisibility: string;

PUBLIC or PRIVATE, default repository visibility in this namespace.

property id

id: string;

ID of Container Registry Enterprise Edition namespace.

property instanceId

instanceId: string;

ID of Container Registry Enterprise Edition instance.

property name

name: string;

Name of Container Registry Enterprise Edition namespace.

interface GetServerlessKubernetesClustersCluster

interface GetServerlessKubernetesClustersCluster

property connections

connections: GetServerlessKubernetesClustersClusterConnections;

Map of serverless cluster connection information. It contains several attributes to Block Connections.

property deletionProtection

deletionProtection: boolean;

Whether the cluster support delete protection.

property endpointPublicAccessEnabled

endpointPublicAccessEnabled: boolean;

property id

id: string;

The ID of the container cluster.

property name

name: string;

The name of the container cluster.

property natGatewayId

natGatewayId: string;

The ID of nat gateway used to launch kubernetes cluster.

property securityGroupId

securityGroupId: string;

The ID of security group where the current cluster is located.

property tags

tags: {[key: string]: any};

property vpcId

vpcId: string;

The ID of VPC where the current cluster is located.

property vswitchId

vswitchId: string;

The ID of VSwitch where the current cluster is located.

interface GetServerlessKubernetesClustersClusterConnections

interface GetServerlessKubernetesClustersClusterConnections

property apiServerInternet

apiServerInternet: string;

API Server Internet endpoint.

property apiServerIntranet

apiServerIntranet: string;

API Server Intranet endpoint.

property masterPublicIp

masterPublicIp: string;

Master node SSH IP address.

interface KubernetesAddon

interface KubernetesAddon

property config

config?: undefined | string;

property name

name?: undefined | string;

The kubernetes cluster’s name. It is unique in one Alicloud account.

interface KubernetesAutoscalerNodepool

interface KubernetesAutoscalerNodepool

property id

id?: undefined | string;

property labels

labels?: undefined | string;

property taints

taints?: undefined | string;

interface KubernetesConnections

interface KubernetesConnections

property apiServerInternet

apiServerInternet: string;

API Server Internet endpoint.

property apiServerIntranet

apiServerIntranet: string;

API Server Intranet endpoint.

property masterPublicIp

masterPublicIp: string;

Master node SSH IP address.

property serviceDomain

serviceDomain: string;

Service Access Domain.

interface KubernetesMasterNode

interface KubernetesMasterNode

property id

id: string;

ID of the node.

property name

name: string;

The kubernetes cluster’s name. It is unique in one Alicloud account.

property privateIp

privateIp: string;

The private IP address of node.

interface KubernetesWorkerNode

interface KubernetesWorkerNode

property id

id: string;

ID of the node.

property name

name: string;

The kubernetes cluster’s name. It is unique in one Alicloud account.

property privateIp

privateIp: string;

The private IP address of node.

interface ManagedKubernetesAddon

interface ManagedKubernetesAddon

property config

config?: undefined | string;

property disabled

disabled?: undefined | string;

property name

name?: undefined | string;

The kubernetes cluster’s name. It is unique in one Alicloud account.

interface ManagedKubernetesConnections

interface ManagedKubernetesConnections

property apiServerInternet

apiServerInternet: string;

API Server Internet endpoint.

property apiServerIntranet

apiServerIntranet: string;

API Server Intranet endpoint.

property masterPublicIp

masterPublicIp: string;

property serviceDomain

serviceDomain: string;

Service Access Domain.

interface ManagedKubernetesWorkerNode

interface ManagedKubernetesWorkerNode

property id

id: string;

ID of the node.

property name

name: string;

The kubernetes cluster’s name. It is unique in one Alicloud account.

property privateIp

privateIp: string;

The private IP address of node.

interface SwarmNode

interface SwarmNode

property eip

eip: string;

The Elastic IP address of node.

property id

id: string;

ID of the node.

property name

name: string;

The container cluster’s name. It is the only in one Alicloud account.

property privateIp

privateIp: string;

The private IP address of node.

property status

status: string;

The node current status. It is different with instance status.

namespace ddos

interface GetDdosBgpInstancesInstance

interface GetDdosBgpInstancesInstance

property bandwidth

bandwidth: number;

The instance’s elastic defend bandwidth.

property baseBandwidth

baseBandwidth: number;

The instance’s base defend bandwidth.

property id

id: string;

The instance’s id.

property ipCount

ipCount: number;

The instance’s count of ip config.

property ipType

ipType: string;

The instance’s IP version.

property name

name: string;

The instance’s remark.

property region

region: string;

A region of instance.

property type

type: string;

The instance’s type.

interface GetDdosCooInstancesInstance

interface GetDdosCooInstancesInstance

property bandwidth

bandwidth: number;

The instance’s elastic defend bandwidth.

property baseBandwidth

baseBandwidth: number;

The instance’s base defend bandwidth.

property domainCount

domainCount: number;

The instance’s count of domain retransmission config.

property id

id: string;

The instance’s id.

property name

name: string;

The instance’s remark.

property portCount

portCount: number;

The instance’s count of port retransmission config.

property serviceBandwidth

serviceBandwidth: number;

The instance’s business bandwidth.

interface SchedulerRuleRule

interface SchedulerRuleRule

property priority

priority?: undefined | number;

property regionId

regionId?: undefined | string;

property status

status: number;

property type

type?: undefined | string;

property value

value?: undefined | string;

property valueType

valueType?: undefined | number;

namespace dds

interface GetMongoInstancesInstance

interface GetMongoInstancesInstance

property availabilityZone

availabilityZone: string;

property chargeType

chargeType: string;

property creationTime

creationTime: string;

property engine

engine: string;

property engineVersion

engineVersion: string;

property expirationTime

expirationTime: string;

property id

id: string;

property instanceClass

instanceClass: string;

property instanceType

instanceType: string;

property lockMode

lockMode: string;

property mongos

mongos: GetMongoInstancesInstanceMongo[];

property name

name: string;

property networkType

networkType: string;

property regionId

regionId: string;

property replication

replication: string;

property shards

shards: GetMongoInstancesInstanceShard[];

property status

status: string;

property storage

storage: number;

property tags

tags: {[key: string]: any};

interface GetMongoInstancesInstanceMongo

interface GetMongoInstancesInstanceMongo

property class

class: string;

property description

description: string;

property nodeId

nodeId: string;

interface GetMongoInstancesInstanceShard

interface GetMongoInstancesInstanceShard

property class

class: string;

property description

description: string;

property nodeId

nodeId: string;

property storage

storage: number;

namespace dns

interface GetAlidnsDomainGroupsGroup

interface GetAlidnsDomainGroupsGroup

property domainCount

domainCount: number;

Number of domain names in the group.

property groupId

groupId: string;

Id of the domain group.

property groupName

groupName: string;

The name of the domain group.

property id

id: string;

Id of the instance.

interface GetAlidnsRecordsRecord

interface GetAlidnsRecordsRecord

property domainName

domainName: string;

The domain name associated to the records.

property id

id: string;

ID of the resource.

property line

line: string;

ISP line. Valid values: default, telecom, unicom, mobile, oversea, edu, drpeng, btvn, .etc. For checking all resolution lines enumeration please visit Alibaba Cloud DNS doc

property locked

locked: boolean;

Indicates whether the record is locked.

property priority

priority: number;

Priority of the MX record.

property recordId

recordId: string;

ID of the record.

property rr

rr: string;

Host record of the domain.

property status

status: string;

Record status. Valid values: ENABLE and DISABLE.

property ttl

ttl: number;

TTL of the record.

property type

type: string;

Record type. Valid values: A, NS, MX, TXT, CNAME, SRV, AAAA, REDIRECT_URL, FORWORD_URL .

property value

value: string;

Host record value of the domain.

interface GetDomainGroupsGroup

interface GetDomainGroupsGroup

property groupId

groupId: string;

property groupName

groupName: string;

interface GetDomainRecordsRecord

interface GetDomainRecordsRecord

property domainName

domainName: string;

property hostRecord

hostRecord: string;

property line

line: string;

property locked

locked: boolean;

property priority

priority: number;

property recordId

recordId: string;

property status

status: string;

property ttl

ttl: number;

property type

type: string;

property value

value: string;

interface GetDomainsDomain

interface GetDomainsDomain

property aliDomain

aliDomain: boolean;

Specifies whether the domain is from Alibaba Cloud or not.

property dnsServers

dnsServers: string[];

DNS list of the domain in the analysis system.

property domainId

domainId: string;

ID of the domain.

property domainName

domainName: string;

Name of the domain.

property groupId

groupId: string;

Id of group that contains the domain.

property groupName

groupName: string;

Name of group that contains the domain.

property instanceId

instanceId: string;

Cloud analysis product ID.

property punyCode

punyCode: string;

Punycode of the Chinese domain.

property versionCode

versionCode: string;

Cloud analysis version code.

interface GetGroupsGroup

interface GetGroupsGroup

property groupId

groupId: string;

Id of the group.

property groupName

groupName: string;

Name of the group.

interface GetInstancesInstance

interface GetInstancesInstance

property dnsSecurity

dnsSecurity: string;

DNS security level.

property domainNumbers

domainNumbers: string;

Number of domain names bound.

property id

id: string;

Id of the instance.

property instanceId

instanceId: string;

Id of the instance resource.

property versionCode

versionCode: string;

Paid package version.

property versionName

versionName: string;

Paid package version name.

interface GetRecordsRecord

interface GetRecordsRecord

property domainName

domainName: string;

The domain name associated to the records.

property hostRecord

hostRecord: string;

Host record of the domain.

property line

line: string;

ISP line. Valid items are default, telecom, unicom, mobile, oversea, edu, drpeng, btvn, .etc. For checking all resolution lines enumeration please visit Alibaba Cloud DNS doc

property locked

locked: boolean;

Indicates whether the record is locked.

property priority

priority: number;

Priority of the MX record.

property recordId

recordId: string;

ID of the record.

property status

status: string;

Record status. Valid items are ENABLE and DISABLE.

property ttl

ttl: number;

TTL of the record.

property type

type: string;

Record type. Valid items are A, NS, MX, TXT, CNAME, SRV, AAAA, REDIRECT_URL, FORWORD_URL .

property value

value: string;

Host record value of the domain.

interface GetResolutionLinesLine

interface GetResolutionLinesLine

property lineCode

lineCode: string;

property lineDisplayName

lineDisplayName: string;

Line display name.

property lineName

lineName: string;

Line name.

namespace drds

interface GetInstancesInstance

interface GetInstancesInstance

property createTime

createTime: number;

Creation time of the instance.

property description

description: string;

The DRDS instance description.

property id

id: string;

The ID of the DRDS instance.

property networkType

networkType: string;

Classic for public classic network or VPC for private network.

property status

status: string;

Status of the instance.

property type

type: string;

The DRDS Instance type.

property version

version: number;

The DRDS Instance version.

property zoneId

zoneId: string;

Zone ID the instance belongs to.

namespace ecs

interface AutoProvisioningGroupLaunchTemplateConfig

interface AutoProvisioningGroupLaunchTemplateConfig

property instanceType

instanceType?: undefined | string;

property maxPrice

maxPrice: string;

property priority

priority?: undefined | string;

property vswitchId

vswitchId: string;

property weightedCapacity

weightedCapacity?: undefined | string;

interface GetDisksDisk

interface GetDisksDisk

property attachedTime

attachedTime: string;

Disk attachment time.

property availabilityZone

availabilityZone: string;

Availability zone of the disk.

property category

category: string;

Disk category. Possible values: cloud (basic cloud disk), cloudEfficiency (ultra cloud disk), ephemeralSsd (local SSD cloud disk), cloudSsd (SSD cloud disk), and cloudEssd (ESSD cloud disk).

property creationTime

creationTime: string;

Disk creation time.

property description

description: string;

Disk description.

property detachedTime

detachedTime: string;

Disk detachment time.

property encrypted

encrypted: string;

Indicate whether the disk is encrypted or not. Possible values: on and off.

property expirationTime

expirationTime: string;

Disk expiration time.

property id

id: string;

ID of the disk.

property imageId

imageId: string;

ID of the image from which the disk is created. It is null unless the disk is created using an image.

property instanceId

instanceId: string;

Filter the results by the specified ECS instance ID.

property name

name: string;

Disk name.

property regionId

regionId: string;

Region ID the disk belongs to.

property resourceGroupId

resourceGroupId: string;

The Id of resource group which the disk belongs.

property size

size: number;

Disk size in GiB.

property snapshotId

snapshotId: string;

Snapshot used to create the disk. It is null if no snapshot is used to create the disk.

property status

status: string;

Current status. Possible values: In_use, Available, Attaching, Detaching, Creating and ReIniting.

property tags

tags?: undefined | {[key: string]: any};

A map of tags assigned to the disks. It must be in the format:

data "alicloud.ecs.getDisks" "disksDs" {
tags = {
tagKey1 = "tagValue1",
tagKey2 = "tagValue2"
}
}

property type

type: string;

Disk type. Possible values: system and data.

interface GetEipsEip

interface GetEipsEip

property bandwidth

bandwidth: string;

EIP internet max bandwidth in Mbps.

property creationTime

creationTime: string;

Time of creation.

property id

id: string;

ID of the EIP.

property instanceId

instanceId: string;

The ID of the instance that is being bound.

property instanceType

instanceType: string;

The instance type of that the EIP is bound.

property internetChargeType

internetChargeType: string;

EIP internet charge type.

property ipAddress

ipAddress: string;

Public IP Address of the the EIP.

property status

status: string;

EIP status. Possible values are: Associating, Unassociating, InUse and Available.

interface GetImagesImage

interface GetImagesImage

property architecture

architecture: string;

Platform type of the image system: i386 or x86_64.

property creationTime

creationTime: string;

Time of creation.

property description

description: string;

Description of the image.

property diskDeviceMappings

diskDeviceMappings: GetImagesImageDiskDeviceMapping[];

Description of the system with disks and snapshots under the image.

property id

id: string;

ID of the image.

property imageId

imageId: string;

property imageOwnerAlias

imageOwnerAlias: string;

Alias of the image owner.

property imageVersion

imageVersion: string;

Version of the image.

property isCopied

isCopied: boolean;

property isSelfShared

isSelfShared: string;

property isSubscribed

isSubscribed: boolean;

Whether the user has subscribed to the terms of service for the image product corresponding to the ProductCode.

property isSupportIoOptimized

isSupportIoOptimized: boolean;

property name

name: string;

property osName

osName: string;

Display Chinese name of the OS.

property osNameEn

osNameEn: string;

Display English name of the OS.

property osType

osType: string;

property platform

platform: string;

property productCode

productCode: string;

Product code of the image on the image market.

property progress

progress: string;

Progress of image creation, presented in percentages.

property size

size: number;

Size of the created disk.

property state

state: string;

property status

status: string;

Status of the image. Possible values: UnAvailable, Available, Creating and CreateFailed.

property tags

tags?: undefined | {[key: string]: any};

property usage

usage: string;

interface GetImagesImageDiskDeviceMapping

interface GetImagesImageDiskDeviceMapping

property device

device: string;

Device information of the created disk: such as /dev/xvdb.

property size

size: string;

Size of the created disk.

property snapshotId

snapshotId: string;

Snapshot ID.

interface GetInstancesInstance

interface GetInstancesInstance

property availabilityZone

availabilityZone: string;

Availability zone where instances are located.

property creationTime

creationTime: string;

Instance creation time.

property description

description: string;

Instance description.

property diskDeviceMappings

diskDeviceMappings: GetInstancesInstanceDiskDeviceMapping[];

Description of the attached disks.

property eip

eip: string;

EIP address the VPC instance is using.

property id

id: string;

ID of the instance.

property imageId

imageId: string;

The image ID of some ECS instance used.

property instanceChargeType

instanceChargeType: string;

Instance charge type.

property instanceType

instanceType: string;

Instance type.

property internetChargeType

internetChargeType: string;

Instance network charge type.

property internetMaxBandwidthOut

internetMaxBandwidthOut: number;

Max output bandwidth for internet.

property keyName

keyName: string;

Key pair the instance is using.

property name

name: string;

Instance name.

property privateIp

privateIp: string;

Instance private IP address.

property publicIp

publicIp: string;

Instance public IP address.

property ramRoleName

ramRoleName: string;

The RAM role name which the instance attaches.

property regionId

regionId: string;

Region ID the instance belongs to.

property resourceGroupId

resourceGroupId: string;

The Id of resource group which the instance belongs.

property securityGroups

securityGroups: string[];

List of security group IDs the instance belongs to.

property spotStrategy

spotStrategy: string;

Spot strategy the instance is using.

property status

status: string;

Instance status. Valid values: “Creating”, “Starting”, “Running”, “Stopping” and “Stopped”. If undefined, all statuses are considered.

property tags

tags?: undefined | {[key: string]: any};

A map of tags assigned to the ECS instances. It must be in the format:

data "alicloud.ecs.getInstances" "taggedInstances" {
tags = {
tagKey1 = "tagValue1",
tagKey2 = "tagValue2"
}
}

property vpcId

vpcId: string;

ID of the VPC linked to the instances.

property vswitchId

vswitchId: string;

ID of the VSwitch linked to the instances.

interface GetInstancesInstanceDiskDeviceMapping

interface GetInstancesInstanceDiskDeviceMapping

property category

category: string;

Cloud disk category.

property device

device: string;

Device information of the created disk: such as /dev/xvdb.

property size

size: number;

Size of the created disk.

property type

type: string;

Cloud disk type: system disk or data disk.

interface GetInstanceTypeFamiliesFamily

interface GetInstanceTypeFamiliesFamily

property generation

generation: string;

The generation of the instance type family, Valid values: ecs-1, ecs-2, ecs-3 and ecs-4. For more information, see Instance type families.

property id

id: string;

ID of the instance type family.

property zoneIds

zoneIds: string[];

A list of Zone to launch the instance.

interface GetInstanceTypesInstanceType

interface GetInstanceTypesInstanceType

property availabilityZones

availabilityZones: string[];

List of availability zones that support the instance type.

property burstableInstance

burstableInstance: GetInstanceTypesInstanceTypeBurstableInstance;

The burstable instance attribution:

property cpuCoreCount

cpuCoreCount: number;

Filter the results to a specific number of cpu cores.

property eniAmount

eniAmount: number;

Filter the result whose network interface number is no more than eniAmount.

property family

family: string;

The instance type family.

property gpu

gpu: GetInstanceTypesInstanceTypeGpu;

The GPU attribution of an instance type:

property id

id: string;

ID of the instance type.

property localStorage

localStorage: GetInstanceTypesInstanceTypeLocalStorage;

Local storage of an instance type:

property memorySize

memorySize: number;

Filter the results to a specific memory size in GB.

property price

price: string;

interface GetInstanceTypesInstanceTypeBurstableInstance

interface GetInstanceTypesInstanceTypeBurstableInstance

property baselineCredit

baselineCredit: string;

The compute performance benchmark CPU credit of a burstable instance.

property initialCredit

initialCredit: string;

The initial CPU credit of a burstable instance.

interface GetInstanceTypesInstanceTypeGpu

interface GetInstanceTypesInstanceTypeGpu

property amount

amount: string;

The number of local storage devices that an instance has been attached to.

property category

category: string;

The category of local storage that an instance has been attached to.

interface GetInstanceTypesInstanceTypeLocalStorage

interface GetInstanceTypesInstanceTypeLocalStorage

property amount

amount: string;

The number of local storage devices that an instance has been attached to.

property capacity

capacity: string;

The capacity of a local storage in GB.

property category

category: string;

The category of local storage that an instance has been attached to.

interface GetKeyPairsKeyPair

interface GetKeyPairsKeyPair

property fingerPrint

fingerPrint: string;

A finger print used to retrieve specified key pair.

property id

id: string;

ID of the key pair.

property instances

instances: GetKeyPairsKeyPairInstance[];

A list of ECS instances that has been bound this key pair.

property keyName

keyName: string;

Name of the key pair.

property resourceGroupId

resourceGroupId: string;

The Id of resource group which the key pair belongs.

property tags

tags?: undefined | {[key: string]: any};

A mapping of tags to assign to the resource.

interface GetKeyPairsKeyPairInstance

interface GetKeyPairsKeyPairInstance

property availabilityZone

availabilityZone: string;

The ID of the availability zone where the ECS instance is located.

property description

description: string;

property imageId

imageId: string;

property instanceId

instanceId: string;

The ID of the ECS instance.

property instanceName

instanceName: string;

The name of the ECS instance.

property instanceType

instanceType: string;

property keyName

keyName: string;

Name of the key pair.

property privateIp

privateIp: string;

The private IP address of the ECS instance.

property publicIp

publicIp: string;

The public IP address or EIP of the ECS instance.

property regionId

regionId: string;

property status

status: string;

property vswitchId

vswitchId: string;

The ID of the VSwitch attached to the ECS instance.

interface GetNetworkInterfacesInterface

interface GetNetworkInterfacesInterface

property creationTime

creationTime: string;

Creation time of the ENI.

property description

description: string;

Description of the ENI.

property id

id: string;

ID of the ENI.

property instanceId

instanceId: string;

ID of the instance that the ENI is attached to.

property mac

mac: string;

MAC address of the ENI.

property name

name: string;

Name of the ENI.

property privateIp

privateIp: string;

Primary private IP of the ENI.

property privateIps

privateIps: string[];

A list of secondary private IP address that is assigned to the ENI.

property publicIp

publicIp: string;

Public IP of the ENI.

property resourceGroupId

resourceGroupId: string;

The Id of resource group.

property securityGroups

securityGroups: string[];

A list of security group that the ENI belongs to.

property status

status: string;

Current status of the ENI.

property tags

tags?: undefined | {[key: string]: any};

A map of tags assigned to the ENI.

property vpcId

vpcId: string;

ID of the VPC that the ENI belongs to.

property vswitchId

vswitchId: string;

ID of the VSwitch that the ENI is linked to.

property zoneId

zoneId: string;

ID of the availability zone that the ENI belongs to.

interface GetSecurityGroupRulesRule

interface GetSecurityGroupRulesRule

property description

description: string;

The description of the rule.

property destCidrIp

destCidrIp: string;

Target IP address segment for egress authorization.

property destGroupId

destGroupId: string;

property destGroupOwnerAccount

destGroupOwnerAccount: string;

Alibaba Cloud account of the target security group.

property direction

direction: string;

Authorization direction. Valid values are: ingress or egress.

property ipProtocol

ipProtocol: string;

The IP protocol. Valid values are: tcp, udp, icmp, gre and all.

property nicType

nicType: string;

Refers to the network type. Can be either internet or intranet. The default value is internet.

property policy

policy: string;

Authorization policy. Can be either accept or drop. The default value is accept.

property portRange

portRange: string;

The range of port numbers.

property priority

priority: number;

Rule priority.

property sourceCidrIp

sourceCidrIp: string;

Source IP address segment for ingress authorization.

property sourceGroupId

sourceGroupId: string;

property sourceGroupOwnerAccount

sourceGroupOwnerAccount: string;

Alibaba Cloud account of the source security group.

interface GetSecurityGroupsGroup

interface GetSecurityGroupsGroup

property creationTime

creationTime: string;

Creation time of the security group.

property description

description: string;

The description of the security group.

property id

id: string;

The ID of the security group.

property innerAccess

innerAccess: boolean;

Whether to allow inner network access.

property name

name: string;

The name of the security group.

property resourceGroupId

resourceGroupId: string;

The Id of resource group which the securityGroup belongs.

property securityGroupType

securityGroupType: string;

The type of the security group.

property tags

tags?: undefined | {[key: string]: any};

A map of tags assigned to the ECS instances. It must be in the format:

data "alicloud.ecs.getSecurityGroups" "taggedSecurityGroups" {
tags = {
tagKey1 = "tagValue1",
tagKey2 = "tagValue2"
}
}

property vpcId

vpcId: string;

Used to retrieve security groups that belong to the specified VPC ID.

interface GetSnapshotsSnapshot

interface GetSnapshotsSnapshot

property creationTime

creationTime: string;

Creation time. Time of creation. It is represented according to ISO8601, and UTC time is used. Format: YYYY-MM-DDThh:mmZ.

property description

description: string;

Description of the snapshot.

property encrypted

encrypted: boolean;

Whether the snapshot is encrypted or not.

property id

id: string;

ID of the snapshot.

property name

name: string;

Name of the snapshot.

property productCode

productCode: string;

Product code on the image market place.

property progress

progress: string;

Progress of snapshot creation, presented in percentage.

property remainTime

remainTime: number;

The remaining time of a snapshot creation task, in seconds.

property retentionDays

retentionDays: number;

The number of days that an automatic snapshot retains in the console for your instance.

property sourceDiskId

sourceDiskId: string;

Source disk ID, which is retained after the source disk of the snapshot is deleted.

property sourceDiskSize

sourceDiskSize: string;

Size of the source disk, measured in GB.

property sourceDiskType

sourceDiskType: string;

Source disk attribute. Value range: * System * Data

property status

status: string;

The snapshot status. Value range: * progressing * accomplished * failed

property usage

usage: string;

Whether the snapshots are used to create resources or not. Value range: * image * disk * imageDisk * none

interface ImageDiskDeviceMapping

interface ImageDiskDeviceMapping

property device

device: string;

Specifies the name of a disk in the combined custom image. Value range: /dev/xvda to /dev/xvdz.

property diskType

diskType: string;

Specifies the type of a disk in the combined custom image. If you specify this parameter, you can use a data disk snapshot as the data source of a system disk for creating an image. If it is not specified, the disk type is determined by the corresponding snapshot. Valid values: system, data,

property size

size: number;

Specifies the size of a disk in the combined custom image, in GiB. Value range: 5 to 2000.

property snapshotId

snapshotId: string;

Specifies a snapshot that is used to create a combined custom image.

interface ImageImportDiskDeviceMapping

interface ImageImportDiskDeviceMapping

property device

device: string;

The name of disk N in the custom image.

property diskImageSize

diskImageSize?: undefined | number;

Resolution size. You must ensure that the system disk space ≥ file system space. Ranges: When n = 1, the system disk: 5 ~ 500GiB, When n = 2 ~ 17, that is, data disk: 5 ~ 1000GiB, When temporary is introduced, the system automatically detects the size, which is subject to the detection result.

property format

format: string;

Image format. Value range: When the RAW, VHD, qcow2 is imported into the image, the system automatically detects the image format, whichever comes first.

property ossBucket

ossBucket?: undefined | string;

Save the exported OSS bucket.

property ossObject

ossObject?: undefined | string;

The file name of your OSS Object.

interface InstanceDataDisk

interface InstanceDataDisk

property autoSnapshotPolicyId

autoSnapshotPolicyId?: undefined | string;

The ID of the automatic snapshot policy applied to the system disk.

property category

category?: undefined | string;

The category of the disk: - cloud: The general cloud disk. - cloudEfficiency: The efficiency cloud disk. - cloudSsd: The SSD cloud disk. - cloudEssd: The ESSD cloud disk. - ephemeralSsd: The local SSD disk. Default to cloudEfficiency.

property deleteWithInstance

deleteWithInstance?: undefined | false | true;

Delete this data disk when the instance is destroyed. It only works on cloud, cloud_efficiency, cloud_essd, cloudSsd disk. If the category of this data disk was ephemeral_ssd, please don’t set this param.

property description

description?: undefined | string;

The description of the data disk.

property encrypted

encrypted?: undefined | false | true;

-(Optional, Bool, ForceNew) Encrypted the data in this disk.

property name

name?: undefined | string;

The name of the data disk.

property size

size: number;

The size of the data disk. - cloud：[5, 2000] - cloud_efficiency：[20, 32768] - cloud_ssd：[20, 32768] - cloud_essd：[20, 32768] - ephemeral_ssd: [5, 800]

property snapshotId

snapshotId?: undefined | string;

The snapshot ID used to initialize the data disk. If the size specified by snapshot is greater that the size of the disk, use the size specified by snapshot as the size of the data disk.

interface LaunchTemplateDataDisk

interface LaunchTemplateDataDisk

property category

category?: undefined | string;

The category of the disk: - cloud: Basic cloud disk. - cloud_efficiency: Ultra cloud disk. - cloud_ssd: SSD cloud Disks. - ephemeral_ssd: local SSD Disks - cloud_essd: ESSD cloud Disks.

property deleteWithInstance

deleteWithInstance?: undefined | false | true;

Delete this data disk when the instance is destroyed. It only works on cloud, cloud_efficiency, cloudSsd and cloudEssd disk. If the category of this data disk was ephemeral_ssd, please don’t set this param.

property description

description?: undefined | string;

The description of the data disk.

property encrypted

encrypted?: undefined | false | true;

-(Optional, Bool) Encrypted the data in this disk.

property name

name?: undefined | string;

The name of the data disk.

property size

size?: undefined | number;

The size of the data disk. - cloud：[5, 2000] - cloud_efficiency：[20, 32768] - cloud_ssd：[20, 32768] - cloud_essd：[20, 32768] - ephemeral_ssd: [5, 800]

property snapshotId

snapshotId?: undefined | string;

The snapshot ID used to initialize the data disk. If the size specified by snapshot is greater that the size of the disk, use the size specified by snapshot as the size of the data disk.

interface LaunchTemplateNetworkInterfaces

interface LaunchTemplateNetworkInterfaces

property description

description?: undefined | string;

The description of the data disk.

property name

name?: undefined | string;

The name of the data disk.

property primaryIp

primaryIp?: undefined | string;

The primary private IP address of the ENI.

property securityGroupId

securityGroupId?: undefined | string;

The security group ID must be one in the same VPC.

property vswitchId

vswitchId?: undefined | string;

The VSwitch ID for ENI. The instance must be in the same zone of the same VPC network as the ENI, but they may belong to different VSwitches.

namespace edas

interface GetApplicationsApplication

interface GetApplicationsApplication

property appId

appId: string;

The ID of the application that you want to deploy.

property appName

appName: string;

The name of your EDAS application. Only letters ‘-’ ‘_’ and numbers are allowed. The length cannot exceed 36 characters.

property applicationType

applicationType: string;

The type of the package for the deployment of the application that you want to create. The valid values are: WAR and JAR. We strongly recommend you to set this parameter when creating the application.

property buildPackageId

buildPackageId: number;

The package ID of Enterprise Distributed Application Service (EDAS) Container.

property clusterId

clusterId: string;

The ID of the cluster that you want to create the application.

property clusterType

clusterType: number;

The type of the cluster that you want to create. Valid values: 1: Swarm cluster. 2: ECS cluster. 3: Kubernates cluster.

property createTime

createTime: number;

Application’s creation time.

property healthCheckUrl

healthCheckUrl: string;

The URL for health checking of the application.

property instanceCount

instanceCount: number;

Number of instances.

property regionId

regionId: string;

The ID of the namespace the application belongs to.

property runningInstanceCount

runningInstanceCount: number;

Number of running instances.

property slbId

slbId: string;

The ID of the SLB instance that is going to be bound.

property slbIp

slbIp: string;

The IP address that is allocated to the bound SLB instance.

property slbPort

slbPort: number;

The port of intranet SLB.

interface GetClustersCluster

interface GetClustersCluster

property clusterId

clusterId: string;

The ID of the cluster that you want to create the application.

property clusterName

clusterName: string;

The name of the cluster.

property clusterType

clusterType: number;

The type of the cluster, Valid values: 1: Swarm cluster. 2: ECS cluster. 3: Kubernates cluster.

property cpu

cpu: number;

The total number of CPUs in the cluster.

property cpuUsed

cpuUsed: number;

The number of used CPUs in the cluster.

property createTime

createTime: number;

Cluster’s creation time.

property mem

mem: number;

The total amount of memory in the cluser. Unit: MB.

property memUsed

memUsed: number;

The amount of used memory in the cluser. Unit: MB.

property networkMode

networkMode: number;

The network type of the cluster. Valid values: 1: classic network. 2: VPC.

property nodeNum

nodeNum: number;

The number of the Elastic Compute Service (ECS) instances that are deployed to the cluster.

property regionId

regionId: string;

The ID of the namespace the application belongs to.

property updateTime

updateTime: number;

The time when the cluster was last updated.

property vpcId

vpcId: string;

The ID of the Virtual Private Cloud (VPC) for the cluster.

interface GetDeployGroupsGroup

interface GetDeployGroupsGroup

property appId

appId: string;

ID of the EDAS application.

property appVersionId

appVersionId: string;

The version of the deployment package for the application.

property clusterId

clusterId: string;

The ID of the cluster that you want to create the application.

property createTime

createTime: number;

The time when the instance group was created.

property groupId

groupId: string;

The ID of the instance group.

property groupName

groupName: string;

The name of the instance group. The length cannot exceed 64 characters.

property groupType

groupType: number;

The type of the instance group. Valid values: 0: Default group. 1: Phased release is disabled for traffic management. 2: Phased release is enabled for traffic management.

property packageVersionId

packageVersionId: string;

The version of the deployment package for the instance group that was created.

property updateTime

updateTime: number;

The time when the instance group was updated.

namespace elasticsearch

interface GetInstancesInstance

interface GetInstancesInstance

property createdAt

createdAt: string;

property dataNodeAmount

dataNodeAmount: number;

property dataNodeDiskSize

dataNodeDiskSize: number;

property dataNodeDiskType

dataNodeDiskType: string;

property dataNodeSpec

dataNodeSpec: string;

property description

description: string;

property id

id: string;

property instanceChargeType

instanceChargeType: string;

property status

status: string;

property tags

tags: {[key: string]: any};

property updatedAt

updatedAt: string;

property version

version: string;

property vswitchId

vswitchId: string;

interface GetZonesZone

interface GetZonesZone

property id

id: string;

ID of the zone.

property multiZoneIds

multiZoneIds: string[];

A list of zone ids in which the multi zone.

namespace emr

interface ClusterBootstrapAction

interface ClusterBootstrapAction

property arg

arg?: undefined | string;

bootstrap action args, e.g. “–a=b”.

property name

name?: undefined | string;

bootstrap action name.

property path

path?: undefined | string;

bootstrap action path, e.g. “oss://bucket/path”.

interface ClusterHostGroup

interface ClusterHostGroup

property autoRenew

autoRenew?: undefined | false | true;

Auto renew for prepaid, true of false. Default is false.

property chargeType

chargeType?: undefined | string;

Charge Type for this group of hosts: PostPaid or PrePaid. If this is not specified, charge type will follow global chargeType value.

property diskCapacity

diskCapacity?: undefined | string;

Data disk capacity.

property diskCount

diskCount?: undefined | string;

Data disk count.

property diskType

diskType?: undefined | string;

Data disk type. Supported value: cloud,cloud_efficiency,cloud_ssd,local_disk,cloud_essd.

property gpuDriver

gpuDriver?: undefined | string;

property hostGroupName

hostGroupName?: undefined | string;

host group name.

property hostGroupType

hostGroupType?: undefined | string;

host group type, supported value: MASTER, CORE or TASK, supported ‘GATEWAY’ available in 1.61.0+.

property instanceList

instanceList?: undefined | string;

Instance list for cluster scale down. This value follows the json format, e.g. [“instanceId1”,“instanceId2”]. escape character for “ is \“.

property instanceType

instanceType?: undefined | string;

Host Ecs instance type.

property nodeCount

nodeCount?: undefined | string;

Host number in this group.

property period

period?: undefined | number;

If charge type is PrePaid, this should be specified, unit is month. Supported value: 1、2、3、4、5、6、7、8、9、12、24、36.

property sysDiskCapacity

sysDiskCapacity?: undefined | string;

System disk capacity.

property sysDiskType

sysDiskType?: undefined | string;

System disk type. Supported value: cloud,cloud_efficiency,cloud_ssd,cloud_essd.

interface GetDiskTypesType

interface GetDiskTypesType

property max

max: number;

The maximum value of the data disk to supported the specific instance type

property min

min: number;

The mininum value of the data disk to supported the specific instance type

property value

value: string;

The value of the data disk or system disk

interface GetInstanceTypesType

interface GetInstanceTypesType

property id

id: string;

The ID of the instance type.

property localStorageCapacity

localStorageCapacity: number;

Local capacity of the applied ecs instance for emr cluster. Unit: GB.

property zoneId

zoneId: string;

The supported resources of specific zoneId.

interface GetMainVersionsMainVersion

interface GetMainVersionsMainVersion

property clusterTypes

clusterTypes: string[];

A list of cluster types the emr cluster supported. Possible values: HADOOP, ZOOKEEPER, KAFKA, DRUID.

property emrVersion

emrVersion: string;

The version of the emr cluster instance. Possible values: EMR-4.0.0, EMR-3.23.0, EMR-3.22.0.

property imageId

imageId: string;

The image id of the emr cluster instance.

namespace ess

interface GetAlarmsAlarm

interface GetAlarmsAlarm

property alarmActions

alarmActions: string[];

The list of actions to execute when this alarm transition into an ALARM state. Each action is specified as ess scaling rule ari.

property cloudMonitorGroupId

cloudMonitorGroupId: number;

Defines the application group id defined by CMS which is assigned when you upload custom metric to CMS, only available for custom metirc.

property comparisonOperator

comparisonOperator: string;

The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand.

property description

description: string;

The description for the alarm.

property dimensions

dimensions: {[key: string]: any};

The dimension map for the alarm’s associated metric.

property enable

enable: boolean;

Whether to enable specific ess alarm.

property evaluationCount

evaluationCount: number;

The number of times that needs to satisfies comparison condition before transition into ALARM state.

property id

id: string;

The id of alarm.

property metricName

metricName: string;

The name for the alarm’s associated metric. See Block_metricNames_and_dimensions below for details.

property metricType

metricType: string;

The type for the alarm’s associated metric. Supported value: system, custom. “system” means the metric data is collected by Aliyun Cloud Monitor Service(CMS), “custom” means the metric data is upload to CMS by users. Defaults to system.

property name

name: string;

The name for ess alarm.

property period

period: number;

The period in seconds over which the specified statistic is applied.

property scalingGroupId

scalingGroupId: string;

Scaling group id the alarms belong to.

property state

state: string;

The state of alarm task.

property statistics

statistics: string;

The statistic to apply to the alarm’s associated metric.

property threshold

threshold: string;

The value against which the specified statistics is compared.

interface GetLifecycleHooksHook

interface GetLifecycleHooksHook

property defaultResult

defaultResult: string;

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses.

property heartbeatTimeout

heartbeatTimeout: number;

Defines the amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action defined in the defaultResult parameter.

property id

id: string;

ID of the lifecycle hook.

property lifecycleTransition

lifecycleTransition: string;

Type of Scaling activity attached to lifecycle hook.

property name

name: string;

Name of the lifecycle hook.

property notificationArn

notificationArn: string;

The Arn of notification target.

property notificationMetadata

notificationMetadata: string;

Additional information that you want to include when Auto Scaling sends a message to the notification target.

property scalingGroupId

scalingGroupId: string;

Scaling group id the lifecycle hooks belong to.

interface GetNotificationsNotification

interface GetNotificationsNotification

property id

id: string;

ID of the notification.

property notificationArn

notificationArn: string;

The Alibaba Cloud Resource Name (ARN) for the notification object.

property notificationTypes

notificationTypes: string[];

The notification types of Auto Scaling events and resource changes.

property scalingGroupId

scalingGroupId: string;

Scaling group id the notifications belong to.

interface GetScalingConfigurationsConfiguration

interface GetScalingConfigurationsConfiguration

property creationTime

creationTime: string;

Creation time of the scaling configuration.

property dataDisks

dataDisks: GetScalingConfigurationsConfigurationDataDisk[];

Data disks of the scaling configuration.

property id

id: string;

ID of the scaling rule.

property imageId

imageId: string;

Image ID of the scaling configuration.

property instanceType

instanceType: string;

Instance type of the scaling configuration.

property internetChargeType

internetChargeType: string;

Internet charge type of the scaling configuration.

property internetMaxBandwidthIn

internetMaxBandwidthIn: number;

Internet max bandwidth in of the scaling configuration.

property internetMaxBandwidthOut

internetMaxBandwidthOut: number;

Internet max bandwidth of the scaling configuration.

property lifecycleState

lifecycleState: string;

Lifecycle state of the scaling configuration.

property name

name: string;

Name of the scaling configuration.

property scalingGroupId

scalingGroupId: string;

Scaling group id the scaling configurations belong to.

property securityGroupId

securityGroupId: string;

Security group ID of the scaling configuration.

property systemDiskCategory

systemDiskCategory: string;

System disk category of the scaling configuration.

property systemDiskSize

systemDiskSize: number;

System disk size of the scaling configuration.

interface GetScalingConfigurationsConfigurationDataDisk

interface GetScalingConfigurationsConfigurationDataDisk

property category

category?: undefined | string;

Category of data disk.

property deleteWithInstance

deleteWithInstance?: undefined | false | true;

Delete_with_instance attribute of data disk.

property device

device?: undefined | string;

Device attribute of data disk.

property size

size?: undefined | number;

Size of data disk.

property snapshotId

snapshotId?: undefined | string;

Size of data disk.

interface GetScalingGroupsGroup

interface GetScalingGroupsGroup

property activeCapacity

activeCapacity: number;

Number of active instances in scaling group.

property activeScalingConfiguration

activeScalingConfiguration: string;

property cooldownTime

cooldownTime: number;

Default cooldown time of scaling group.

property creationTime

creationTime: string;

Creation time of scaling group.

property dbInstanceIds

dbInstanceIds: string[];

Db instances id which the ECS instance attached to.

property id

id: string;

ID of the scaling group.

property launchTemplateId

launchTemplateId: string;

Active launch template ID for scaling group.

property launchTemplateVersion

launchTemplateVersion: string;

Version of active launch template.

property lifecycleState

lifecycleState: string;

Lifecycle state of scaling group.

property loadBalancerIds

loadBalancerIds: string[];

Slb instances id which the ECS instance attached to.

property maxSize

maxSize: number;

The maximum number of ECS instances.

property minSize

minSize: number;

The minimum number of ECS instances.

property name

name: string;

Name of the scaling group. * activeScalingConfiguration -Active scaling configuration for scaling group.

property pendingCapacity

pendingCapacity: number;

Number of pending instances in scaling group.

property regionId

regionId: string;

Region ID the scaling group belongs to.

property removalPolicies

removalPolicies: string[];

Removal policy used to select the ECS instance to remove from the scaling group.

property removingCapacity

removingCapacity: number;

Number of removing instances in scaling group.

property totalCapacity

totalCapacity: number;

Number of instances in scaling group.

property vswitchIds

vswitchIds: string[];

Vswitches id in which the ECS instance launched.

interface GetScalingRulesRule

interface GetScalingRulesRule

property adjustmentType

adjustmentType: string;

Adjustment type of the scaling rule.

property adjustmentValue

adjustmentValue: number;

Adjustment value of the scaling rule.

property cooldown

cooldown: number;

Cooldown time of the scaling rule.

property id

id: string;

ID of the scaling rule.

property minAdjustmentMagnitude

minAdjustmentMagnitude: number;

Min adjustment magnitude of scaling rule.

property name

name: string;

Name of the scaling rule.

property scalingGroupId

scalingGroupId: string;

Scaling group id the scaling rules belong to.

property scalingRuleAri

scalingRuleAri: string;

Ari of scaling rule.

property type

type: string;

Type of scaling rule.

interface GetScheduledTasksTask

interface GetScheduledTasksTask

property description

description: string;

Description of the scheduled task.

property id

id: string;

ID of the scheduled task id.

property launchExpirationTime

launchExpirationTime: number;

The time period during which a failed scheduled task is retried.

property launchTime

launchTime: string;

The time at which the scheduled task is triggered.

property maxValue

maxValue: number;

property minValue

minValue: number;

property name

name: string;

Name of the scheduled task name.

property recurrenceEndTime

recurrenceEndTime: string;

Specifies the end time after which the scheduled task is no longer repeated.

property recurrenceType

recurrenceType: string;

Specifies the recurrence type of the scheduled task.

property recurrenceValue

recurrenceValue: string;

Specifies how often a scheduled task recurs.

property scheduledAction

scheduledAction: string;

The operation to be performed when a scheduled task is triggered.

property taskEnabled

taskEnabled: boolean;

interface ScalingConfigurationDataDisk

interface ScalingConfigurationDataDisk

property category

category?: undefined | string;

property deleteWithInstance

deleteWithInstance?: undefined | false | true;

property device

device?: undefined | string;

property size

size?: undefined | number;

property snapshotId

snapshotId?: undefined | string;

interface ScalingGroupVServerGroupsVserverGroup

interface ScalingGroupVServerGroupsVserverGroup

property loadbalancerId

loadbalancerId: string;

property vserverAttributes

vserverAttributes: ScalingGroupVServerGroupsVserverGroupVserverAttribute[];

interface ScalingGroupVServerGroupsVserverGroupVserverAttribute

interface ScalingGroupVServerGroupsVserverGroupVserverAttribute

property port

port: number;

property vserverGroupId

vserverGroupId: string;

property weight

weight: number;

interface ScalingRuleStepAdjustment

interface ScalingRuleStepAdjustment

property metricIntervalLowerBound

metricIntervalLowerBound?: undefined | string;

property metricIntervalUpperBound

metricIntervalUpperBound?: undefined | string;

property scalingAdjustment

scalingAdjustment?: undefined | number;

namespace fc

interface GetFunctionsFunction

interface GetFunctionsFunction

property codeChecksum

codeChecksum: string;

Checksum (crc64) of the function code.

property codeSize

codeSize: number;

Function code size in bytes.

property creationTime

creationTime: string;

Function creation time.

property description

description: string;

Function description.

property environmentVariables

environmentVariables: {[key: string]: any};

A map that defines environment variables for the function.

property handler

handler: string;

Function entry point in the code.

property id

id: string;

Function ID.

property lastModificationTime

lastModificationTime: string;

Function last modification time.

property memorySize

memorySize: number;

Amount of memory in MB the function can use at runtime.

property name

name: string;

Function name.

property runtime

runtime: string;

Function runtime. The list of possible values is available here.

property timeout

timeout: number;

Maximum amount of time the function can run in seconds.

interface GetServicesService

interface GetServicesService

property creationTime

creationTime: string;

FC service creation time.

property description

description: string;

FC service description.

property id

id: string;

FC service ID.

property internetAccess

internetAccess: boolean;

Indicate whether the service can access to internet or not.

property lastModificationTime

lastModificationTime: string;

FC service last modification time.

property logConfig

logConfig: GetServicesServiceLogConfig;

A list of one element containing information about the associated log store. It contains the following attributes:

property name

name: string;

FC service name.

property role

role: string;

FC service role ARN.

property vpcConfig

vpcConfig: GetServicesServiceVpcConfig;

A list of one element containing information about accessible VPC resources. It contains the following attributes:

interface GetServicesServiceLogConfig

interface GetServicesServiceLogConfig

property logstore

logstore: string;

Log Service store name.

property project

project: string;

Log Service project name.

interface GetServicesServiceVpcConfig

interface GetServicesServiceVpcConfig

property securityGroupId

securityGroupId: string;

Associated security group ID.

property vpcId

vpcId: string;

Associated VPC ID.

property vswitchIds

vswitchIds: string[];

Associated VSwitch IDs.

interface GetTriggersTrigger

interface GetTriggersTrigger

property config

config: string;

JSON-encoded trigger configuration. See Configure triggers and events for more details.

property creationTime

creationTime: string;

FC trigger creation time.

property id

id: string;

FC trigger ID.

property invocationRole

invocationRole: string;

RAM role arn attached to the Function Compute trigger. Role used by the event source to call the function. The value format is “acs:ram::$account-id:role/$role-name”. See Create a trigger for more details.

property lastModificationTime

lastModificationTime: string;

FC trigger last modification time.

property name

name: string;

FC trigger name.

property sourceArn

sourceArn: string;

Event source resource address. See Create a trigger for more details.

property type

type: string;

Type of the trigger. Valid values: oss, log, timer, http and mnsTopic.

interface GetZonesZone

interface GetZonesZone

property id

id: string;

ID of the zone.

interface ServiceLogConfig

interface ServiceLogConfig

property logstore

logstore: string;

The log store name of Logs service.

property project

project: string;

The project name of Logs service.

interface ServiceVpcConfig

interface ServiceVpcConfig

property securityGroupId

securityGroupId: string;

A security group ID associated with the FC service.

property vpcId

vpcId: string;

property vswitchIds

vswitchIds: string[];

A list of vswitch IDs associated with the FC service.

namespace gpdb

interface GetInstancesInstance

interface GetInstancesInstance

property availabilityZone

availabilityZone: string;

Instance availability zone.

property chargeType

chargeType: string;

Billing method. Value options are PostPaid for Pay-As-You-Go and PrePaid for yearly or monthly subscription.

property creationTime

creationTime: string;

The time when you create an instance. The format is YYYY-MM-DDThh:mm:ssZ, such as 2011-05-30T12:11:4Z.

property description

description: string;

The description of an instance.

property engine

engine: string;

Database engine type. Supported option is gpdb.

property engineVersion

engineVersion: string;

Database engine version.

property id

id: string;

The instance id.

property instanceClass

instanceClass: string;

The group type.

property instanceGroupCount

instanceGroupCount: string;

The number of groups.

property instanceNetworkType

instanceNetworkType: string;

property regionId

regionId: string;

Region ID the instance belongs to.

property status

status: string;

Status of the instance.

interface GetZonesZone

interface GetZonesZone

property id

id: string;

ID of the zone.

property multiZoneIds

multiZoneIds: string[];

A list of zone ids in which the multi zone.

namespace hbase

interface GetInstancesInstance

interface GetInstancesInstance

property backupStatus

backupStatus: string;

the Backup Status of the instance.

property coreDiskSize

coreDiskSize: number;

core node disk size, unit:GB.

property coreDiskType

coreDiskType: string;

cloud_ssd or cloud_efficiency

property coreInstanceType

coreInstanceType: string;

hbase.sn1.large, hbase.sn1.large, hbase.n1.2xlarge and so on.

property coreNodeCount

coreNodeCount: number;

same with “coreInstanceQuantity”

property createdTime

createdTime: string;

property deletionProtection

deletionProtection: boolean;

the switch of delete protection.

property engine

engine: string;

the engine of the instance.

property engineVersion

engineVersion: string;

the engineVersion of the instance.

property expireTime

expireTime: string;

the expire time of the instance.

property id

id: string;

The ID of the HBase instance.

property masterInstanceType

masterInstanceType: string;

hbase.sn1.large, hbase.sn1.large, hbase.n1.2xlarge and so on.

property masterNodeCount

masterNodeCount: number;

the node count of master

property name

name: string;

The name of the HBase instance.

property networkType

networkType: string;

Classic network or VPC.

property payType

payType: string;

Billing method. Value options are PostPaid for Pay-As-You-Go and PrePaid for yearly or monthly subscription.

property regionId

regionId: string;

Region ID the instance belongs to.

property status

status: string;

Status of the instance.

property tags

tags?: undefined | {[key: string]: any};

A mapping of tags to assign to the resource.

property vpcId

vpcId: string;

VPC ID the instance belongs to.

property vswitchId

vswitchId: string;

VSwitch ID the instance belongs to.

property zoneId

zoneId: string;

Zone ID the instance belongs to.

interface GetZonesZone

interface GetZonesZone

property id

id: string;

ID of the zone.

property multiZoneIds

multiZoneIds: string[];

A list of zone ids in which the multi zone.

namespace kms

interface GetAliasesAlias

interface GetAliasesAlias

property aliasName

aliasName: string;

The unique identifier of the alias.

property id

id: string;

ID of the alias. The value is same as KMS alias_name.

property keyId

keyId: string;

ID of the key.

interface GetKeysKey

interface GetKeysKey

property arn

arn: string;

The Alibaba Cloud Resource Name (ARN) of the key.

property creationDate

creationDate: string;

Creation date of key.

property creator

creator: string;

The owner of the key.

property deleteDate

deleteDate: string;

Deletion date of key.

property description

description: string;

Description of the key.

property id

id: string;

ID of the key.

property status

status: string;

Filter the results by status of the KMS keys. Valid values: Enabled, Disabled, PendingDeletion.

interface GetKeyVersionsVersion

interface GetKeyVersionsVersion

property creationDate

creationDate: string;

Date and time when the key version was created (UTC time).

property id

id: string;

ID of the KMS KeyVersion resource.

property keyId

keyId: string;

The id of kms key.

property keyVersionId

keyVersionId: string;

ID of the key version.

interface GetSecretsSecret

interface GetSecretsSecret

property id

id: string;

ID of the Kms Secret. The value is same as KMS secret_name.

property plannedDeleteTime

plannedDeleteTime: string;

Schedule deletion time.

property secretName

secretName: string;

Name of the KMS Secret.

property tags

tags: {[key: string]: any};

A mapping of tags to assign to the resource.

namespace kvstore

interface GetInstanceClassesClass

interface GetInstanceClassesClass

property instanceClass

instanceClass: string;

KVStore available instance class.

property price

price: string;

interface GetInstanceEnginesInstanceEngine

interface GetInstanceEnginesInstanceEngine

property engine

engine: string;

Database type. Options are Redis, Memcache. Default to Redis.

property engineVersion

engineVersion: string;

Database version required by the user. Value options of Redis can refer to the latest docs detail info EngineVersion. Value of Memcache should be empty.

property zoneId

zoneId: string;

The Zone to launch the KVStore instance.

interface GetInstancesInstance

interface GetInstancesInstance

property availabilityZone

availabilityZone: string;

Availability zone.

property bandwidth

bandwidth: number;

Instance bandwidth limit. Unit: Mbit/s.

property capacity

capacity: number;

Capacity of the applied ApsaraDB for Redis instance. Unit: MB.

property chargeType

chargeType: string;

Billing method. Value options: PostPaid for Pay-As-You-Go and PrePaid for subscription.

property connectionDomain

connectionDomain: string;

property connections

connections: number;

Instance connection quantity limit. Unit: count.

property createTime

createTime: string;

Creation time of the instance.

property expireTime

expireTime: string;

Expiration time. Pay-As-You-Go instances are never expire.

property id

id: string;

The ID of the RKV instance.

property instanceClass

instanceClass: string;

Type of the applied ApsaraDB for Redis instance. For more information, see Instance type table.

property instanceType

instanceType: string;

Database type. Options are Memcache, and Redis. If no value is specified, all types are returned.

property name

name: string;

The name of the RKV instance.

property port

port: number;

Connection port of the instance.

property privateIp

privateIp: string;

Private IP address of the instance.

property regionId

regionId: string;

Region ID the instance belongs to.

property status

status: string;

Status of the instance.

property userName

userName: string;

property vpcId

vpcId: string;

Used to retrieve instances belong to specified VPC.

property vswitchId

vswitchId: string;

Used to retrieve instances belong to specified vswitch resources.

interface GetZonesZone

interface GetZonesZone

property id

id: string;

ID of the zone.

property multiZoneIds

multiZoneIds: string[];

A list of zone ids in which the multi zone.

interface InstanceParameter

interface InstanceParameter

property name

name: string;

property value

value: string;

namespace log

interface AlertNotificationList

interface AlertNotificationList

property content

content: string;

Notice content of alarm.

property emailLists

emailLists?: string[];

Email address list.

property mobileLists

mobileLists?: string[];

SMS sending mobile number.

property serviceUri

serviceUri?: undefined | string;

Request address.

property type

type: string;

Notification type. support Email, SMS, DingTalk.

interface AlertQueryList

interface AlertQueryList

property chartTitle

chartTitle: string;

chart title

property end

end: string;

end time. example: 20s.

property logstore

logstore: string;

Query logstore

property query

query: string;

query corresponding to chart. example: * AND aliyun.

property start

start: string;

begin time. example: -60s.

property timeSpanType

timeSpanType?: undefined | string;

default Custom. No need to configure this parameter.

interface StoreIndexFieldSearch

interface StoreIndexFieldSearch

property alias

alias?: undefined | string;

The alias of one field.

property caseSensitive

caseSensitive?: undefined | false | true;

Whether the case sensitive for the field. Default to false. It is valid when “type” is “text” or “json”.

property enableAnalytics

enableAnalytics?: undefined | false | true;

Whether to enable field analytics. Default to true.

property includeChinese

includeChinese?: undefined | false | true;

Whether includes the chinese for the field. Default to false. It is valid when “type” is “text” or “json”.

property jsonKeys

jsonKeys?: StoreIndexFieldSearchJsonKey[];

Use nested index when type is json

property name

name: string;

When using the jsonKeys field, this field is required.

property token

token?: undefined | string;

The string of several split words, like “\r”, “#”. It is valid when “type” is “text” or “json”.

property type

type?: undefined | string;

The type of one field. Valid values: [“long”, “text”, “double”]. Default to “long”

interface StoreIndexFieldSearchJsonKey

interface StoreIndexFieldSearchJsonKey

property alias

alias?: undefined | string;

The alias of one field.

property docValue

docValue?: undefined | false | true;

Whether to enable statistics. default to true.

property name

name: string;

When using the jsonKeys field, this field is required.

property type

type?: undefined | string;

The type of one field. Valid values: [“long”, “text”, “double”]. Default to “long”

interface StoreIndexFullText

interface StoreIndexFullText

property caseSensitive

caseSensitive?: undefined | false | true;

Whether the case sensitive for the field. Default to false. It is valid when “type” is “text” or “json”.

property includeChinese

includeChinese?: undefined | false | true;

Whether includes the chinese for the field. Default to false. It is valid when “type” is “text” or “json”.

property token

token?: undefined | string;

The string of several split words, like “\r”, “#”. It is valid when “type” is “text” or “json”.

interface StoreShard

interface StoreShard

property beginKey

beginKey: string;

property endKey

endKey: string;

property id

id: number;

The ID of the log project. It formats of <project>:<name>.

property status

status: string;

namespace marketplace

interface GetProductProduct

interface GetProductProduct

property code

code: string;

The code of the product.

property description

description: string;

The description of the product.

property name

name: string;

The name of the product.

property skuses

skuses: GetProductProductSkus[];

A list of one element containing sku attributes of an object. Each element contains the following attributes:

interface GetProductProductSkus

interface GetProductProductSkus

property images

images: GetProductProductSkusImage[];

The list of custom ECS images, Each element contains the following attributes:

property packageVersions

packageVersions: GetProductProductSkusPackageVersion[];

The list of package version details of this product sku, Each element contains the following attributes:

property skuCode

skuCode: string;

The sku code of this product sku.

property skuName

skuName: string;

The sku name of this product sku.

interface GetProductProductSkusImage

interface GetProductProductSkusImage

property imageId

imageId: string;

The Ecs image id.

property imageName

imageName: string;

The Ecs image display name.

property regionId

regionId: string;

The Ecs image region.

interface GetProductProductSkusPackageVersion

interface GetProductProductSkusPackageVersion

property packageName

packageName: string;

The package name of this product sku package.

property packageVersion

packageVersion: string;

The package version of this product sku package. Currently, the API products can return package_version, but others can not for ensure.

interface GetProductsProduct

interface GetProductsProduct

property categoryId

categoryId: number;

The Category ID of products. For more information, see DescribeProducts.

property code

code: string;

The code of the product.

property deliveryDate

deliveryDate: string;

The delivery date of the product.

property deliveryWay

deliveryWay: string;

The delivery way of the product.

property imageUrl

imageUrl: string;

The image URL of the product.

property name

name: string;

The name of the product.

property operationSystem

operationSystem: string;

The operation system of the product.

property score

score: string;

The rating information of the product.

property shortDescription

shortDescription: string;

The short description of the product.

property suggestedPrice

suggestedPrice: string;

The suggested price of the product.

property supplierId

supplierId: number;

The supplier id of the product.

property supplierName

supplierName: string;

The supplier name of the product.

property tags

tags: string;

The tags of the product.

property targetUrl

targetUrl: string;

The detail page URL of the product.

property warrantyDate

warrantyDate: string;

The warranty date of the product.

namespace mns

interface GetQueuesQueue

interface GetQueuesQueue

property delaySeconds

delaySeconds: number;

This attribute defines the length of time, in seconds, after which every message sent to the queue is dequeued.

property id

id: string;

The id of the queue, The value is set to name.

property maximumMessageSize

maximumMessageSize: number;

This indicates the maximum length, in bytes, of any message body sent to the queue.

property messageRetentionPeriod

messageRetentionPeriod: number;

Messages are deleted from the queue after a specified length of time, whether they have been activated or not. This attribute defines the viability period, in seconds, for every message in the queue.

property name

name: string;

The name of the queue

property pollingWaitSeconds

pollingWaitSeconds: number;

Long polling is measured in seconds. When this attribute is set to 0, long polling is disabled. When it is not set to 0, long polling is enabled and message dequeue requests will be processed only when valid messages are received or when long polling times out.

property visibilityTimeouts

visibilityTimeouts: number;

Dequeued messages change from active (visible) status to inactive (invisible) status. This attribute defines the length of time, in seconds, that messages remain invisible. Messages return to active status after the set period.

interface GetTopicsTopic

interface GetTopicsTopic

property id

id: string;

The id of the topic. The value is set to name.

property loggingEnabled

loggingEnabled: boolean;

Whether to enable logging.

property maximumMessageSize

maximumMessageSize: number;

This indicates the maximum length, in bytes, of any message body sent to the topic.

property name

name: string;

The name of the topic.

interface GetTopicSubscriptionsSubscription

interface GetTopicSubscriptionsSubscription

property endpoint

endpoint: string;

Describe the terminal address of the message received in this subscription. * filterTag- A string to filter resulting messages of the topic by their message tag.

property filterTag

filterTag: string;

property id

id: string;

The ID of the topic subscription. The value is set to name.

property name

name: string;

The name of the subscription. * topicName- The topic which The subscription belongs to was named with the name.

property notifyContentFormat

notifyContentFormat: string;

The NotifyContentFormat attribute of Subscription. This attribute specifies the content format of the messages pushed to users.

property notifyStrategy

notifyStrategy: string;

The NotifyStrategy attribute of Subscription. This attribute specifies the retry strategy when message sending fails.

property topicName

topicName: string;

Two topics on a single account in the same region cannot have the same name. A topic name must start with an English letter or a digit, and can contain English letters, digits, and hyphens, with the length not exceeding 256 characters.

namespace mongodb

interface GetInstancesInstance

interface GetInstancesInstance

property availabilityZone

availabilityZone: string;

Instance availability zone.

property chargeType

chargeType: string;

Billing method. Value options are PostPaid for Pay-As-You-Go and PrePaid for yearly or monthly subscription.

property creationTime

creationTime: string;

Creation time of the instance in RFC3339 format.

property engine

engine: string;

Database engine type. Supported option is MongoDB.

property engineVersion

engineVersion: string;

Database engine version.

property expirationTime

expirationTime: string;

Expiration time in RFC3339 format. Pay-As-You-Go instances are never expire.

property id

id: string;

The ID of the MongoDB instance.

property instanceClass

instanceClass: string;

Sizing of the instance to be queried.

property instanceType

instanceType: string;

Type of the instance to be queried. If it is set to sharding, the sharded cluster instances are listed. If it is set to replicate, replica set instances are listed. Default value replicate.

property lockMode

lockMode: string;

Lock status of the instance.

property mongos

mongos: GetInstancesInstanceMongo[];

Array composed of Mongos.

property name

name: string;

The name of the MongoDB instance.

property networkType

networkType: string;

Classic network or VPC.

property regionId

regionId: string;

Region ID the instance belongs to.

property replication

replication: string;

Replication factor corresponds to number of nodes. Optional values are 1 for single node and 3 for three nodes replica set.

property shards

shards: GetInstancesInstanceShard[];

Array composed of shards.

property status

status: string;

Status of the instance.

property storage

storage: number;

Shard disk.

property tags

tags: {[key: string]: any};

A mapping of tags to assign to the resource.

interface GetInstancesInstanceMongo

interface GetInstancesInstanceMongo

property class

class: string;

Shard instance specification.

property description

description: string;

Shard instance description.

property nodeId

nodeId: string;

Shard instance ID.

interface GetInstancesInstanceShard

interface GetInstancesInstanceShard

property class

class: string;

Shard instance specification.

property description

description: string;

Shard instance description.

property nodeId

nodeId: string;

Shard instance ID.

property storage

storage: number;

Shard disk.

interface GetZonesZone

interface GetZonesZone

property id

id: string;

ID of the zone.

property multiZoneIds

multiZoneIds: string[];

A list of zone ids in which the multi zone.

interface ShardingInstanceMongoList

interface ShardingInstanceMongoList

property connectString

connectString: string;

Mongo node connection string

property nodeClass

nodeClass: string;

-(Required) Node specification. see Instance specifications.

property nodeId

nodeId: string;

The ID of the shard-node.

property port

port: number;

Mongo node port * shardList

interface ShardingInstanceShardList

interface ShardingInstanceShardList

property nodeClass

nodeClass: string;

-(Required) Node specification. see Instance specifications.

property nodeId

nodeId: string;

The ID of the shard-node.

property nodeStorage

nodeStorage: number;
  • Custom storage space; value range: [10, 1,000]
  • 10-GB increments. Unit: GB.

namespace nas

interface GetAccessGroupsGroup

interface GetAccessGroupsGroup

property description

description: string;

Filter results by a specific Description.

property id

id: string;

AccessGroupName of the AccessGroup.

property mountTargetCount

mountTargetCount: number;

MountTargetCount block of the AccessGroup

property ruleCount

ruleCount: number;

RuleCount of the AccessGroup.

property type

type: string;

Filter results by a specific AccessGroupType.

interface GetAccessRulesRule

interface GetAccessRulesRule

property accessRuleId

accessRuleId: string;

AccessRuleId of the AccessRule.

property priority

priority: number;

Priority of the AccessRule.

property rwAccess

rwAccess: string;

Filter results by a specific RWAccess.

property sourceCidrIp

sourceCidrIp: string;

Filter results by a specific SourceCidrIp.

property userAccess

userAccess: string;

Filter results by a specific UserAccess.

interface GetFileSystemsSystem

interface GetFileSystemsSystem

property createTime

createTime: string;

Time of creation.

property description

description: string;

Destription of the FileSystem.

property id

id: string;

ID of the FileSystem.

property meteredSize

meteredSize: number;

MeteredSize of the FileSystem.

property protocolType

protocolType: string;

Filter results by a specific ProtocolType.

property regionId

regionId: string;

ID of the region where the FileSystem is located.

property storageType

storageType: string;

Filter results by a specific StorageType.

interface GetMountTargetsTarget

interface GetMountTargetsTarget

property accessGroupName

accessGroupName: string;

Filter results by a specific AccessGroupName.

property id

id: string;

ID of the MountTargetDomain.

property mountTargetDomain

mountTargetDomain: string;

Filter results by a specific MountTargetDomain.

property type

type: string;

Filter results by a specific NetworkType.

property vpcId

vpcId: string;

Filter results by a specific VpcId.

property vswitchId

vswitchId: string;

Filter results by a specific VSwitchId.

namespace oss

interface BucketCorsRule

interface BucketCorsRule

property allowedHeaders

allowedHeaders?: string[];

Specifies which headers are allowed.

property allowedMethods

allowedMethods: string[];

Specifies which methods are allowed. Can be GET, PUT, POST, DELETE or HEAD.

property allowedOrigins

allowedOrigins: string[];

Specifies which origins are allowed.

property exposeHeaders

exposeHeaders?: string[];

Specifies expose header in the response.

property maxAgeSeconds

maxAgeSeconds?: undefined | number;

Specifies time in seconds that browser can cache the response for a preflight request.

interface BucketLifecycleRule

interface BucketLifecycleRule

property enabled

enabled: boolean;

Specifies lifecycle rule status.

property expirations

expirations?: BucketLifecycleRuleExpiration[];

Specifies a period in the object’s expire (documented below).

property id

id: string;

Unique identifier for the rule. If omitted, OSS bucket will assign a unique name.

property prefix

prefix: string;

Object key prefix identifying one or more objects to which the rule applies.

property transitions

transitions?: BucketLifecycleRuleTransition[];

Specifies the time when an object is converted to the IA or archive storage class during a valid life cycle. (documented below).

interface BucketLifecycleRuleExpiration

interface BucketLifecycleRuleExpiration

property date

date?: undefined | string;

Specifies the date after which you want the corresponding action to take effect. The value obeys ISO8601 format like 2017-03-09.

property days

days?: undefined | number;

Specifies the number of days after object creation when the specific rule action takes effect.

interface BucketLifecycleRuleTransition

interface BucketLifecycleRuleTransition

property createdBeforeDate

createdBeforeDate?: undefined | string;

Specifies the time before which the rules take effect. The date must conform to the ISO8601 format and always be UTC 00:00. For example: 2002-10-11T00:00:00.000Z indicates that objects updated before 2002-10-11T00:00:00.000Z are deleted or converted to another storage class, and objects updated after this time (including this time) are not deleted or converted.

property days

days?: undefined | number;

Specifies the number of days after object creation when the specific rule action takes effect.

property storageClass

storageClass?: undefined | string;

Specifies the storage class that objects that conform to the rule are converted into. The storage class of the objects in a bucket of the IA storage class can be converted into Archive but cannot be converted into Standard. Values: IA, Archive.

interface BucketLogging

interface BucketLogging

property targetBucket

targetBucket: string;

The name of the bucket that will receive the log objects.

property targetPrefix

targetPrefix?: undefined | string;

To specify a key prefix for log objects.

interface BucketRefererConfig

interface BucketRefererConfig

property allowEmpty

allowEmpty: boolean;

Allows referer to be empty. Defaults false.

property referers

referers: string[];

The list of referer.

interface BucketServerSideEncryptionRule

interface BucketServerSideEncryptionRule

property sseAlgorithm

sseAlgorithm: string;

The server-side encryption algorithm to use. Possible values: AES256 and KMS.

interface BucketVersioning

interface BucketVersioning

property status

status: string;

Specifies the versioning state of a bucket. Valid values: Enabled and Suspended.

interface BucketWebsite

interface BucketWebsite

property errorDocument

errorDocument?: undefined | string;

An absolute path to the document to return in case of a 4XX error.

property indexDocument

indexDocument: string;

Alicloud OSS returns this index document when requests are made to the root domain or any of the subfolders.

interface GetBucketObjectsObject

interface GetBucketObjectsObject

property acl

acl: string;

Object access control list. Possible values: default, private, public-read and public-read-write.

property cacheControl

cacheControl: string;

Caching behavior along the request/reply chain. Read RFC2616 Cache-Control for further details.

property contentDisposition

contentDisposition: string;

Presentational information for the object. Read RFC2616 Content-Disposition for further details.

property contentEncoding

contentEncoding: string;

Content encodings that have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. Read RFC2616 Content-Encoding for further details.

property contentLength

contentLength: string;

Size of the object in bytes.

property contentMd5

contentMd5: string;

MD5 value of the content. Read MD5 for computing method.

property contentType

contentType: string;

Standard MIME type describing the format of the object data, e.g. “application/octet-stream”.

property etag

etag: string;

ETag generated for the object (MD5 sum of the object content).

property expires

expires: string;

Expiration date for the the request/response. Read RFC2616 Expires for further details.

property key

key: string;

Object key.

property lastModificationTime

lastModificationTime: string;

Last modification time of the object.

property serverSideEncryption

serverSideEncryption: string;

Server-side encryption of the object in OSS. It can be empty or AES256.

property sseKmsKeyId

sseKmsKeyId: string;

If present, specifies the ID of the Key Management Service(KMS) master encryption key that was used for the object.

property storageClass

storageClass: string;

Object storage type. Possible values: Standard, IA and Archive.

interface GetBucketsBucket

interface GetBucketsBucket

property acl

acl: string;

Bucket access control list. Possible values: private, public-read and public-read-write.

property corsRules

corsRules: GetBucketsBucketCorsRule[];

A list of CORS rule configurations. Each element contains the following attributes:

property creationDate

creationDate: string;

Bucket creation date.

property extranetEndpoint

extranetEndpoint: string;

Internet domain name for accessing the bucket from outside.

property intranetEndpoint

intranetEndpoint: string;

Intranet domain name for accessing the bucket from an ECS instance in the same region.

property lifecycleRules

lifecycleRules: GetBucketsBucketLifecycleRule[];

A list CORS of lifecycle configurations. When Lifecycle is enabled, OSS automatically deletes the objects or transitions the objects (to another storage class) corresponding the lifecycle rules on a regular basis. Each element contains the following attributes:

property location

location: string;

Region of the data center where the bucket is located.

property logging

logging: GetBucketsBucketLogging;

A list of one element containing configuration parameters used for storing access log information. It contains the following attributes:

property name

name: string;

Bucket name.

property owner

owner: string;

Bucket owner.

property policy

policy?: undefined | string;

property refererConfig

refererConfig: GetBucketsBucketRefererConfig;

A list of one element containing referer configuration. It contains the following attributes:

property serverSideEncryptionRule

serverSideEncryptionRule: GetBucketsBucketServerSideEncryptionRule;

A configuration of default encryption for a bucket. It contains the following attributes:

property storageClass

storageClass: string;

Object storage type. Possible values: Standard, IA and Archive.

property tags

tags: {[key: string]: any};

A mapping of tags.

property versioning

versioning: GetBucketsBucketVersioning;

If present , the versioning state has been set on the bucket. It contains the following attribute.

property website

website: GetBucketsBucketWebsite;

A list of one element containing configuration parameters used when the bucket is used as a website. It contains the following attributes:

interface GetBucketsBucketCorsRule

interface GetBucketsBucketCorsRule

property allowedHeaders

allowedHeaders: string[];

Control whether the headers specified by Access-Control-Request-Headers in the OPTIONS prefetch command are allowed. Each header specified by Access-Control-Request-Headers must match a value in AllowedHeader. Each rule allows up to one wildcard “*” .

property allowedMethods

allowedMethods: string[];

Specify the allowed methods for cross-domain requests. Possible values: GET, PUT, DELETE, POST and HEAD.

property allowedOrigins

allowedOrigins: string[];

The origins allowed for cross-domain requests. Multiple elements can be used to specify multiple allowed origins. Each rule allows up to one wildcard “*”. If “*” is specified, cross-domain requests of all origins are allowed.

property exposeHeaders

exposeHeaders: string[];

Specify the response headers allowing users to access from an application (for example, a Javascript XMLHttpRequest object). The wildcard “*” is not allowed.

property maxAgeSeconds

maxAgeSeconds: number;

Specify the cache time for the returned result of a browser prefetch (OPTIONS) request to a specific resource.

interface GetBucketsBucketLifecycleRule

interface GetBucketsBucketLifecycleRule

property enabled

enabled: boolean;

Indicate whether the rule is enabled or not.

property expiration

expiration: GetBucketsBucketLifecycleRuleExpiration;

A list of one element containing expiration attributes of an object. It contains the following attributes:

property id

id: string;

Unique ID of the rule.

property prefix

prefix: string;

Prefix applicable to a rule. Only those objects with a matching prefix can be affected by the rule.

interface GetBucketsBucketLifecycleRuleExpiration

interface GetBucketsBucketLifecycleRuleExpiration

property date

date?: undefined | string;

Date after which the rule to take effect. The format is like 2017-03-09.

property days

days?: undefined | number;

Indicate the number of days after the last object update until the rules take effect.

interface GetBucketsBucketLogging

interface GetBucketsBucketLogging

property targetBucket

targetBucket: string;

Bucket for storing access logs.

property targetPrefix

targetPrefix: string;

Prefix of the saved access log file paths.

interface GetBucketsBucketRefererConfig

interface GetBucketsBucketRefererConfig

property allowEmpty

allowEmpty: boolean;

Indicate whether the access request referer field can be empty.

property referers

referers: string[];

Referer access whitelist.

interface GetBucketsBucketServerSideEncryptionRule

interface GetBucketsBucketServerSideEncryptionRule

property sseAlgorithm

sseAlgorithm: string;

The server-side encryption algorithm to use.

interface GetBucketsBucketVersioning

interface GetBucketsBucketVersioning

property status

status: string;

A bucket versioning state. Possible values:Enabled and Suspended.

interface GetBucketsBucketWebsite

interface GetBucketsBucketWebsite

property errorDocument

errorDocument: string;

Key of the HTML document containing the error page.

property indexDocument

indexDocument: string;

Key of the HTML document containing the home page.

interface GetInstanceAttachmentsAttachment

interface GetInstanceAttachmentsAttachment

property domain

domain: string;

The domain of the instance attachment.

property endpoint

endpoint: string;

The access endpoint of the instance attachment.

property id

id: string;

The resource ID, the value is same as “instanceName”.

property instanceName

instanceName: string;

The name of OTS instance.

property region

region: string;

The region of the instance attachment.

property vpcId

vpcId: string;

The ID of attaching VPC to instance.

property vpcName

vpcName: string;

The name of attaching VPC to instance.

interface GetInstancesInstance

interface GetInstancesInstance

property clusterType

clusterType: string;

The cluster type of the instance. Possible values: SSD, HYBRID.

property createTime

createTime: string;

The create time of the instance.

property description

description: string;

The description of the instance.

property entityQuota

entityQuota: number;

The instance quota which indicating the maximum number of tables.

property id

id: string;

ID of the instance.

property name

name: string;

Instance name.

property network

network: string;

The network type of the instance. Possible values: NORMAL, VPC, VPC_CONSOLE.

property readCapacity

readCapacity: number;

The maximum adjustable read capacity unit of the instance.

property status

status: string;

Instance status. Possible values: Running, Disabled, Deleting.

property tags

tags: {[key: string]: any};

A map of tags assigned to the instance. It must be in the format:

data "alicloud.oss.getInstances" "instancesDs" {
tags = {
tagKey1 = "tagValue1",
tagKey2 = "tagValue2"
}
}

property userId

userId: string;

The user id of the instance.

property writeCapacity

writeCapacity: number;

The maximum adjustable write capacity unit of the instance.

interface GetTablesTable

interface GetTablesTable

property id

id: string;

ID of the table. The value is <instance_name>:<table_name>.

property instanceName

instanceName: string;

The name of OTS instance.

property maxVersion

maxVersion: number;

The maximum number of versions stored in this table.

property primaryKeys

primaryKeys: GetTablesTablePrimaryKey[];

The property of TableMeta which indicates the structure information of a table.

property tableName

tableName: string;

The table name of the OTS which could not be changed.

property timeToLive

timeToLive: number;

The retention time of data stored in this table.

interface GetTablesTablePrimaryKey

interface GetTablesTablePrimaryKey

property name

name: string;

property type

type: string;

namespace ots

interface TablePrimaryKey

interface TablePrimaryKey

property name

name: string;

Name for primary key.

property type

type: string;

Type for primary key. Only Integer, String or Binary is allowed.

namespace polardb

interface ClusterParameter

interface ClusterParameter

property name

name: string;

property value

value: string;

interface GetAccountsAccount

interface GetAccountsAccount

property accountDescription

accountDescription: string;

Account description.

property accountLockState

accountLockState: string;

Account lock state, Valid values are Lock, UnLock.

property accountName

accountName: string;

Account name.

property accountStatus

accountStatus: string;

Cluster address type.Cluster: the default address of the Cluster.Primary: Primary address.Custom: Custom cluster addresses.

property accountType

accountType: string;

Account type, Valid values are Normal, Super.

property databasePrivileges

databasePrivileges: GetAccountsAccountDatabasePrivilege[];

A list of database privilege. Each element contains the following attributes.

interface GetAccountsAccountDatabasePrivilege

interface GetAccountsAccountDatabasePrivilege

property accountPrivilege

accountPrivilege: string;

Account privilege of database

property dbName

dbName: string;

The account owned database name

interface GetClustersCluster

interface GetClustersCluster

property chargeType

chargeType: string;

Billing method. Value options: PostPaid for Pay-As-You-Go and PrePaid for subscription.

property createTime

createTime: string;

The createTime of the db_nodes.

property dbNodeClass

dbNodeClass: string;

The dbNodeClass of the db_nodes.

property dbNodeNumber

dbNodeNumber: number;

The DBNodeNumber of the PolarDB cluster.

property dbNodes

dbNodes: GetClustersClusterDbNode[];

The DBNodes of the PolarDB cluster.

property dbType

dbType: string;

Database type. Options are MySQL, Oracle and PostgreSQL. If no value is specified, all types are returned.

property dbVersion

dbVersion: string;

The DBVersion of the PolarDB cluster.

property deleteLock

deleteLock: number;

The DeleteLock of the PolarDB cluster.

property description

description: string;

The description of the PolarDB cluster.

property engine

engine: string;

Database type. Options are MySQL, Oracle and PostgreSQL. If no value is specified, all types are returned.

property expireTime

expireTime: string;

Expiration time. Pay-As-You-Go clusters never expire.

property expired

expired: string;

The expired of the PolarDB cluster.

property id

id: string;

The ID of the PolarDB cluster.

property lockMode

lockMode: string;

The LockMode of the PolarDB cluster.

property networkType

networkType: string;

The DBClusterNetworkType of the PolarDB cluster.

property regionId

regionId: string;

The regionId of the db_nodes.

property status

status: string;

status of the cluster.

property storageUsed

storageUsed: number;

The StorageUsed of the PolarDB cluster.

property vpcId

vpcId: string;

ID of the VPC the cluster belongs to.

property zoneId

zoneId: string;

The zoneId of the db_nodes.

interface GetClustersClusterDbNode

interface GetClustersClusterDbNode

property createTime

createTime: string;

The createTime of the db_nodes.

property dbNodeClass

dbNodeClass: string;

The dbNodeClass of the db_nodes.

property dbNodeId

dbNodeId: string;

The dbNodeId of the db_nodes.

property dbNodeRole

dbNodeRole: string;

The dbNodeRole of the db_nodes.

property dbNodeStatus

dbNodeStatus: string;

The dbNodeStatus of the db_nodes.

property maxConnections

maxConnections: number;

The maxConnections of the db_nodes.

property maxIops

maxIops: number;

The maxIops of the db_nodes.

property regionId

regionId: string;

The regionId of the db_nodes.

property zoneId

zoneId: string;

The zoneId of the db_nodes.

interface GetDatabasesDatabase

interface GetDatabasesDatabase

property accounts

accounts: GetDatabasesDatabaseAccount[];

A list of accounts of database. Each element contains the following attributes.

property characterSetName

characterSetName: string;

The character set name of database.

property dbDescription

dbDescription: string;

Database description.

property dbName

dbName: string;

Database name.

property dbStatus

dbStatus: string;

The status of database.

property engine

engine: string;

The engine of database.

interface GetDatabasesDatabaseAccount

interface GetDatabasesDatabaseAccount

property accountName

accountName: string;

Account name.

property accountStatus

accountStatus: string;

Account status.

property privilegeStatus

privilegeStatus: string;

The privilege status of account.

interface GetEndpointsEndpoint

interface GetEndpointsEndpoint

property addressItems

addressItems: GetEndpointsEndpointAddressItem[];

A list of endpoint addresses. Each element contains the following attributes.

property autoAddNewNodes

autoAddNewNodes: string;

Whether the new node is automatically added to the default cluster address.Options are Enable and Disable.

property dbEndpointId

dbEndpointId: string;

endpoint of the cluster.

property endpointConfig

endpointConfig: string;

The Endpoint configuration. ConsistLevel: session consistency level, value:0: final consistency,1: session consistency;LoadBalanceStrategy: load balancing strategy. Based on the automatic scheduling of load, the value is: load.

property endpointType

endpointType: string;

Cluster address type.Cluster: the default address of the Cluster.Primary: Primary address.Custom: Custom cluster addresses.

property nodes

nodes: string;

A list of nodes that connect to the address configuration.

property readWriteMode

readWriteMode: string;

Read-write mode:ReadWrite: readable and writable (automatic read-write separation).ReadOnly: ReadOnly.

interface GetEndpointsEndpointAddressItem

interface GetEndpointsEndpointAddressItem

property connectionString

connectionString: string;

Connection instance string.

property ipAddress

ipAddress: string;

The ip address of connection string.

property netType

netType: string;

IP network type:Public or Private.

property port

port: string;

Intranet connection port.

property vpcId

vpcId: string;

ID of the VPC the instance belongs to.

property vswitchId

vswitchId: string;

ID of the VSwitch the cluster belongs to.

interface GetNodeClassesClass

interface GetNodeClassesClass

property supportedEngines

supportedEngines: GetNodeClassesClassSupportedEngine[];

A list of PolarDB node classes in the zone.

property zoneId

zoneId: string;

The Zone to launch the PolarDB cluster.

interface GetNodeClassesClassSupportedEngine

interface GetNodeClassesClassSupportedEngine

property availableResources

availableResources: GetNodeClassesClassSupportedEngineAvailableResource[];

A list of PolarDB node available classes.

property engine

engine: string;

In the zone, the database type supports classes in the following available_resources.

interface GetNodeClassesClassSupportedEngineAvailableResource

interface GetNodeClassesClassSupportedEngineAvailableResource

property dbNodeClass

dbNodeClass: string;

The PolarDB node class type by the user.

interface GetZonesZone

interface GetZonesZone

property id

id: string;

ID of the zone.

property multiZoneIds

multiZoneIds: string[];

A list of zone ids in which the multi zone.

namespace pvtz

interface GetZoneRecordsRecord

interface GetZoneRecordsRecord

property id

id: number;

ID of the Private Zone Record.

property priority

priority: number;

Priority of the Private Zone Record.

property resourceRecord

resourceRecord: string;

Resource record of the Private Zone Record.

property status

status: string;

property ttl

ttl: number;

Ttl of the Private Zone Record.

property type

type: string;

Type of the Private Zone Record.

property value

value: string;

Value of the Private Zone Record.

interface GetZonesZone

interface GetZonesZone

property bindVpcs

bindVpcs: GetZonesZoneBindVpc[];

List of the VPCs is bound to the Private Zone.

property creationTime

creationTime: string;

Time of creation of the Private Zone.

property id

id: string;

ID of the Private Zone.

property isPtr

isPtr: boolean;

Whether the Private Zone is ptr

property name

name: string;

Name of the Private Zone.

property recordCount

recordCount: number;

Count of the Private Zone Record.

property remark

remark: string;

Remark of the Private Zone.

property updateTime

updateTime: string;

Time of update of the Private Zone.

interface GetZonesZoneBindVpc

interface GetZonesZoneBindVpc

property regionId

regionId: string;

property vpcId

vpcId: string;

property vpcName

vpcName: string;

interface ZoneAttachmentVpc

interface ZoneAttachmentVpc

property regionId

regionId: string;

The region of the vpc. If not set, the current region will instead of.

property vpcId

vpcId: string;

The Id of the vpc.

namespace ram

interface GetGroupsGroup

interface GetGroupsGroup

property comments

comments: string;

Comments of the group.

property name

name: string;

Name of the group.

interface GetPoliciesPolicy

interface GetPoliciesPolicy

property attachmentCount

attachmentCount: number;

Attachment count of the policy.

property createDate

createDate: string;

Creation date of the policy.

property defaultVersion

defaultVersion: string;

Default version of the policy.

property description

description: string;

Description of the policy.

property document

document: string;

Policy document of the policy.

property name

name: string;

Name of the policy.

property type

type: string;

Filter results by a specific policy type. Valid values are Custom and System.

property updateDate

updateDate: string;

Update date of the policy.

interface GetRolesRole

interface GetRolesRole

property arn

arn: string;

Resource descriptor of the role.

property assumeRolePolicyDocument

assumeRolePolicyDocument: string;

Authorization strategy of the role. This parameter is deprecated and replaced by document.

property createDate

createDate: string;

Creation date of the role.

property description

description: string;

Description of the role.

property document

document: string;

Authorization strategy of the role.

property id

id: string;

Id of the role.

property name

name: string;

Name of the role.

property updateDate

updateDate: string;

Update date of the role.

interface GetUsersUser

interface GetUsersUser

property createDate

createDate: string;

Creation date of the user.

property id

id: string;

The original id is user name, but it is user id in 1.37.0+.

property name

name: string;

Name of the user.

interface PolicyStatement

interface PolicyStatement

property actions

actions: string[];

(It has been deprecated from version 1.49.0, and use field ‘document’ to replace.) List of operations for the resource. The format of each item in this list is ${service}:${action_name}, such as oss:ListBuckets and ecs:Describe*. The ${service} can be ecs, oss, ots and so on, the ${action_name} refers to the name of an api interface which related to the ${service}.

property effect

effect: string;

(It has been deprecated from version 1.49.0, and use field ‘document’ to replace.) This parameter indicates whether or not the action is allowed. Valid values are Allow and Deny.

property resources

resources: string[];

(It has been deprecated from version 1.49.0, and use field ‘document’ to replace.) List of specific objects which will be authorized. The format of each item in this list is acs:${service}:${region}:${account_id}:${relative_id}, such as acs:ecs:*:*:instance/inst-002 and acs:oss:*:1234567890000:mybucket. The ${service} can be ecs, oss, ots and so on, the ${region} is the region info which can use * replace when it is not supplied, the ${account_id} refers to someone’s Alicloud account id or you can use * to replace, the ${relative_id} is the resource description section which related to the ${service}.

namespace rds

interface GetInstanceClassesInstanceClass

interface GetInstanceClassesInstanceClass

property instanceClass

instanceClass: string;

DB Instance available class.

property price

price: string;

property storageRange

storageRange: GetInstanceClassesInstanceClassStorageRange;

DB Instance available storage range.

property zoneIds

zoneIds: GetInstanceClassesInstanceClassZoneId[];

A list of Zone to launch the DB instance.

interface GetInstanceClassesInstanceClassStorageRange

interface GetInstanceClassesInstanceClassStorageRange

property max

max: string;

DB Instance available storage max value.

property min

min: string;

DB Instance available storage min value.

property step

step: string;

DB Instance available storage increase step.

interface GetInstanceClassesInstanceClassZoneId

interface GetInstanceClassesInstanceClassZoneId

property id

id: string;

The Zone to launch the DB instance

property subZoneIds

subZoneIds: string[];

A list of sub zone ids which in the id - e.g If id is cn-beijing-MAZ5(a,b), subZoneIds will be ["cn-beijing-a", "cn-beijing-b"].

interface GetInstanceEnginesInstanceEngine

interface GetInstanceEnginesInstanceEngine

property category

category: string;

DB Instance category.

property engine

engine: string;

Database type. Options are MySQL, SQLServer, PostgreSQL and PPAS. If no value is specified, all types are returned.

property engineVersion

engineVersion: string;

Database version required by the user. Value options can refer to the latest docs detail info EngineVersion.

property zoneIds

zoneIds: GetInstanceEnginesInstanceEngineZoneId[];

A list of Zone to launch the DB instance.

interface GetInstanceEnginesInstanceEngineZoneId

interface GetInstanceEnginesInstanceEngineZoneId

property id

id: string;

The Zone to launch the DB instance

property subZoneIds

subZoneIds: string[];

A list of sub zone ids which in the id - e.g If id is cn-beijing-MAZ5(a,b), subZoneIds will be ["cn-beijing-a", "cn-beijing-b"].

interface GetInstancesInstance

interface GetInstancesInstance

property availabilityZone

availabilityZone: string;

Availability zone.

property chargeType

chargeType: string;

Billing method. Value options: Postpaid for Pay-As-You-Go and Prepaid for subscription.

property connectionMode

connectionMode: string;

Standard for standard access mode and Safe for high security access mode.

property connectionString

connectionString: string;

(Available in 1.70.3+) RDS database connection string.

property createTime

createTime: string;

Creation time of the instance.

property dbInstanceStorageType

dbInstanceStorageType: string;

(Available in 1.70.3+) The storage type of the instance.

property dbType

dbType: string;

Primary for primary instance, Readonly for read-only instance, Guard for disaster recovery instance, and Temp for temporary instance.

property engine

engine: string;

Database type. Options are MySQL, SQLServer, PostgreSQL and PPAS. If no value is specified, all types are returned.

property engineVersion

engineVersion: string;

Database version.

property expireTime

expireTime: string;

Expiration time. Pay-As-You-Go instances never expire.

property guardInstanceId

guardInstanceId: string;

If a disaster recovery instance is attached to the current instance, the ID of the disaster recovery instance applies.

property id

id: string;

The ID of the RDS instance.

property instanceStorage

instanceStorage: number;

(Available in 1.70.3+) User-defined DB instance storage space.

property instanceType

instanceType: string;

Sizing of the RDS instance.

property masterInstanceId

masterInstanceId: string;

ID of the primary instance. If this parameter is not returned, the current instance is a primary instance.

property name

name: string;

The name of the RDS instance.

property netType

netType: string;

Internet for public network or Intranet for private network.

property port

port: string;

(Available in 1.70.3+) RDS database connection port.

property readonlyInstanceIds

readonlyInstanceIds: string[];

A list of IDs of read-only instances attached to the primary instance.

property regionId

regionId: string;

Region ID the instance belongs to.

property status

status: string;

Status of the instance.

property tempInstanceId

tempInstanceId: string;

If a temporary instance is attached to the current instance, the ID of the temporary instance applies.

property vpcId

vpcId: string;

Used to retrieve instances belong to specified VPC.

property vswitchId

vswitchId: string;

Used to retrieve instances belong to specified vswitch resources.

interface GetZonesZone

interface GetZonesZone

property id

id: string;

ID of the zone.

property multiZoneIds

multiZoneIds: string[];

A list of zone ids in which the multi zone.

interface InstanceParameter

interface InstanceParameter

property name

name: string;

property value

value: string;

interface ReadOnlyInstanceParameter

interface ReadOnlyInstanceParameter

property name

name: string;

property value

value: string;

namespace resourcemanager

interface GetAccountsAccount

interface GetAccountsAccount

property accountId

accountId: string;

property displayName

displayName: string;

property folderId

folderId: string;

The ID of the folder.

property id

id: string;

The ID of the resource. * accountId- The ID of the account. * displayName- The name of the member account.

property joinMethod

joinMethod: string;

The way in which the member account joined the resource directory.

property joinTime

joinTime: string;

The time when the member account joined the resource directory.

property modifyTime

modifyTime: string;

The time when the member account was modified.

property resourceDirectoryId

resourceDirectoryId: string;

The ID of the resource directory.

property status

status: string;

The status of the member account.

property type

type: string;

The type of the member account.

interface GetFoldersFolder

interface GetFoldersFolder

property folderId

folderId: string;

property folderName

folderName: string;

property id

id: string;

The ID of the folder. * folderId- The ID of the folder. * folderName- The name of the folder.

interface GetHandshakesHandshake

interface GetHandshakesHandshake

property expireTime

expireTime: string;

The time when the invitation expires.

property handshakeId

handshakeId: string;

property id

id: string;

The ID of the resource. * handshakeId- The ID of the invitation.

property masterAccountId

masterAccountId: string;

The ID of the master account of the resource directory.

property masterAccountName

masterAccountName: string;

The name of the master account of the resource directory.

property modifyTime

modifyTime: string;

The time when the invitation was modified.

property note

note: string;

The invitation note.

property resourceDirectoryId

resourceDirectoryId: string;

The ID of the resource directory.

property status

status: string;

The status of the invitation.

property targetEntity

targetEntity: string;

The ID or logon email address of the invited account.

property targetType

targetType: string;

The type of the invited account.

interface GetPoliciesPolicy

interface GetPoliciesPolicy

property attachmentCount

attachmentCount: number;

The number of times the policy is referenced.

property createDate

createDate: string;

The time when the policy was created.

property defaultVersion

defaultVersion: string;

The default version of the policy.

property description

description: string;

The description of the policy.

property id

id: string;

The ID of the policy. * policyName- The name of the policy. * policyType- The type of the policy.

property policyName

policyName: string;

property policyType

policyType: string;

The type of the policy. If you do not specify this parameter, the system lists all types of policies. Valid values: Custom and System.

property updateDate

updateDate: string;

The time when the policy was updated.

interface GetPolicyVersionsVersion

interface GetPolicyVersionsVersion

property createDate

createDate: string;

property id

id: string;

The ID of the resource, the value is <policy_name>:<version_id>. * versionId- The ID of the policy version. * createDate- The time when the policy version was created. * isDefaultVersion- Indicates whether the policy version is the default version.

property isDefaultVersion

isDefaultVersion: boolean;

property versionId

versionId: string;

interface GetResourceDirectoriesDirectory

interface GetResourceDirectoriesDirectory

property id

id: string;

The ID of resource directory. * masterAccountId- The ID of the master account. * masterAccountName- The name of the master account.

property masterAccountId

masterAccountId: string;

property masterAccountName

masterAccountName: string;

property resourceDirectoryId

resourceDirectoryId: string;

The ID of the resource directory.

property rootFolderId

rootFolderId: string;

The ID of the root folder.

interface GetResourceGroupsGroup

interface GetResourceGroupsGroup

property accountId

accountId: string;

The ID of the Alibaba Cloud account to which the resource group belongs.

property createDate

createDate: string;

The time when the resource group was created.

property displayName

displayName: string;

The display name of the resource group.

property id

id: string;

The ID of the resource group.

property name

name: string;

The unique identifier of the resource group.

property status

status: string;

The status of the resource group. Possible values:Creating,Deleted,OK and PendingDelete.

interface GetRolesRole

interface GetRolesRole

property arn

arn: string;

property createDate

createDate: string;

property description

description: string;

property id

id: string;

The ID of the role. * roleId- The ID of the role. * roleName- The name of the role. * arn- The Alibaba Cloud Resource Name (ARN) of the RAM role. * createDate- The time when the RAM role was created. * updateDate- The time when the RAM role was updated. * description- The description of the RAM role. * maxSessionDuration- The maximum session duration of the RAM role.

property maxSessionDuration

maxSessionDuration: number;

property roleId

roleId: string;

property roleName

roleName: string;

property updateDate

updateDate: string;

interface ResourceGroupRegionStatus

interface ResourceGroupRegionStatus

property regionId

regionId: string;

property status

status: string;

The status of the resource group.

namespace rocketmq

interface GetGroupsGroup

interface GetGroupsGroup

property id

id: string;

The name of the group.

property independentNaming

independentNaming: boolean;

Indicates whether namespaces are available. Read Fields in SubscribeInfoDo for further details.

property owner

owner: string;

The ID of the group owner, which is the Alibaba Cloud UID.

property remark

remark: string;

Remark of the group.

interface GetInstancesInstance

interface GetInstancesInstance

property id

id: string;

ID of the instance.

property instanceId

instanceId: string;

ID of the instance.

property instanceName

instanceName: string;

Name of the instance.

property instanceStatus

instanceStatus: number;

The status of the instance. Read Fields in InstanceVO for further details.

property instanceType

instanceType: number;

The type of the instance. Read Fields in InstanceVO for further details.

property releaseTime

releaseTime: number;

The automatic release time of an Enterprise Platinum Edition instance.

interface GetTopicsTopic

interface GetTopicsTopic

property createTime

createTime: string;

Time of creation.

property independentNaming

independentNaming: boolean;

Indicates whether namespaces are available. Read Fields in PublishInfoDo for further details.

property messageType

messageType: number;

The type of the message. Read Fields in PublishInfoDo for further details.

property owner

owner: string;

The ID of the topic owner, which is the Alibaba Cloud UID.

property relation

relation: number;

The relation ID. Read Fields in PublishInfoDo for further details.

property relationName

relationName: string;

The name of the relation, for example, owner, publishable, subscribable, and publishable and subscribable.

property remark

remark: string;

Remark of the topic.

property topic

topic: string;

The name of the topic.

namespace sag

interface GetAclsAcl

interface GetAclsAcl

property id

id: string;

The ID of the ACL. For example “acl-xxx”.

property name

name: string;

The name of the Acl.

namespace slb

interface AclEntryList

interface AclEntryList

property comment

comment?: undefined | string;

property entry

entry: string;

interface BackendServerBackendServer

interface BackendServerBackendServer

property serverId

serverId: string;

property type

type?: undefined | string;

property weight

weight: number;

interface GetAclsAcl

interface GetAclsAcl

property entryLists

entryLists: GetAclsAclEntryList[];

A list of entry (IP addresses or CIDR blocks). Each entry contains two sub-fields as Entry Block follows.

property id

id: string;

Acl ID.

property ipVersion

ipVersion: string;

property name

name: string;

Acl name.

property relatedListeners

relatedListeners: GetAclsAclRelatedListener[];

A list of listener are attached by the acl. Each listener contains four sub-fields as Listener Block follows.

property resourceGroupId

resourceGroupId: string;

The Id of resource group which acl belongs.

property tags

tags?: undefined | {[key: string]: any};

A mapping of tags to assign to the resource.

interface GetAclsAclEntryList

interface GetAclsAclEntryList

property comment

comment: string;

property entry

entry: string;

interface GetAclsAclRelatedListener

interface GetAclsAclRelatedListener

property aclType

aclType: string;

property frontendPort

frontendPort: number;

property loadBalancerId

loadBalancerId: string;

property protocol

protocol: string;

interface GetAttachmentsSlbAttachment

interface GetAttachmentsSlbAttachment

property instanceId

instanceId: string;

ID of the attached ECS instance.

property weight

weight: number;

Weight associated to the ECS instance.

interface GetBackendServersBackendServer

interface GetBackendServersBackendServer

property id

id: string;

backend server ID.

property serverType

serverType: string;

Type of the backend server.

property weight

weight: number;

Weight associated to the ECS instance.

interface GetCaCertificatesCertificate

interface GetCaCertificatesCertificate

property commonName

commonName: string;

CA certificate common name.

property createdTime

createdTime: string;

CA certificate created time.

property createdTimestamp

createdTimestamp: number;

CA certificate created timestamp.

property expiredTime

expiredTime: string;

CA certificate expired time.

property expiredTimestamp

expiredTimestamp: number;

CA certificate expired timestamp.

property fingerprint

fingerprint: string;

CA certificate fingerprint.

property id

id: string;

CA certificate ID.

property name

name: string;

CA certificate name.

property regionId

regionId: string;

The region Id of CA certificate.

property resourceGroupId

resourceGroupId: string;

The Id of resource group which ca certificates belongs.

property tags

tags?: undefined | {[key: string]: any};

A mapping of tags to assign to the resource.

interface GetDomainExtensionsExtension

interface GetDomainExtensionsExtension

property domain

domain: string;

The domain name.

property id

id: string;

The ID of the domain extension.

property serverCertificateId

serverCertificateId: string;

The ID of the certificate used by the domain name.

interface GetListenersSlbListener

interface GetListenersSlbListener

property backendPort

backendPort: number;

Port opened on the backend server to receive requests.

property bandwidth

bandwidth: number;

Peak bandwidth. If the value is set to -1, the listener is not limited by bandwidth.

property caCertificateId

caCertificateId: string;

ID of the CA certificate (only required when two-way authentication is used). Only available when the protocol is https.

cookie: string;

Cookie configured by the backend server. Only available when the stickySessionType is server.

property cookieTimeout

cookieTimeout: number;

Cookie timeout in seconds. Only available when the stickySessionType is insert.

property description

description: string;

The description of slb listener.

property enableHttp2

enableHttp2: string;

Whether to enable https listener support http2 or not. Valid values are on and off. Default to on.

property establishedTimeout

establishedTimeout: number;

Connection timeout in seconds for the Layer 4 TCP listener. Only available when the protocol is tcp.

property frontendPort

frontendPort: number;

Filter listeners by the specified frontend port.

property gzip

gzip: string;

Indicate whether Gzip compression is enabled or not. Possible values are on and off. Only available when the protocol is http or https.

property healthCheck

healthCheck: string;

Indicate whether health check is enabled of not. Possible values are on and off.

property healthCheckConnectPort

healthCheckConnectPort: number;

Port used for health check.

property healthCheckConnectTimeout

healthCheckConnectTimeout: number;

Amount of time in seconds to wait for the response for a health check.

property healthCheckDomain

healthCheckDomain: string;

Domain name used for health check. The SLB sends HTTP head requests to the backend server, the domain is useful when the backend server verifies the host field in the requests. Only available when the protocol is http, https or tcp (in this case healthCheckType must be http).

property healthCheckHttpCode

healthCheckHttpCode: string;

HTTP status codes indicating that the health check is normal. It can contain several comma-separated values such as “http_2xx,http_3xx”. Only available when the protocol is http, https or tcp (in this case healthCheckType must be http).

property healthCheckInterval

healthCheckInterval: number;

Time interval between two consecutive health checks.

property healthCheckTimeout

healthCheckTimeout: number;

Amount of time in seconds to wait for the response from a health check. If an ECS instance sends no response within the specified timeout period, the health check fails. Only available when the protocol is http or https.

property healthCheckType

healthCheckType: string;

Health check method. Possible values are tcp and http. Only available when the protocol is tcp.

property healthCheckUri

healthCheckUri: string;

URI used for health check. Only available when the protocol is http, https or tcp (in this case healthCheckType must be http).

property healthyThreshold

healthyThreshold: number;

Number of consecutive successes of health check performed on the same ECS instance (from failure to success).

property idleTimeout

idleTimeout: number;

Timeout of http or https listener established connection idle timeout. Valid value range: [1-60] in seconds. Default to 15.

property masterSlaveServerGroupId

masterSlaveServerGroupId: string;

ID of the active/standby server group.

property persistenceTimeout

persistenceTimeout: number;

Timeout value of the TCP connection in seconds. If the value is 0, the session persistence function is disabled. Only available when the protocol is tcp.

property protocol

protocol: string;

Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.

property requestTimeout

requestTimeout: number;

Timeout of http or https listener request (which does not get response from backend) timeout. Valid value range: [1-180] in seconds. Default to 60.

property scheduler

scheduler: string;

Algorithm used to distribute traffic. Possible values: wrr (weighted round robin), wlc (weighted least connection) and rr (round robin).

property securityStatus

securityStatus: string;

Security status. Only available when the protocol is https.

property serverCertificateId

serverCertificateId: string;

property serverGroupId

serverGroupId: string;

ID of the linked VServer group.

property sslCertificateId

sslCertificateId: string;

ID of the server certificate. Only available when the protocol is https.

property status

status: string;

Listener status.

property stickySession

stickySession: string;

Indicate whether session persistence is enabled or not. If enabled, all session requests from the same client are sent to the same backend server. Possible values are on and off. Only available when the protocol is http or https.

property stickySessionType

stickySessionType: string;

Method used to handle the cookie. Possible values are insert (cookie added to the response) and server (cookie set by the backend server). Only available when the protocol is http or https and stickySession is on.

property tlsCipherPolicy

tlsCipherPolicy: string;

Https listener TLS cipher policy. Valid values are tlsCipherPolicy10, tlsCipherPolicy11, tlsCipherPolicy12, tlsCipherPolicy12Strict. Default to tlsCipherPolicy10.

property unhealthyThreshold

unhealthyThreshold: number;

Number of consecutive failures of health check performed on the same ECS instance (from success to failure).

property xForwardedFor

xForwardedFor: string;

Indicate whether the HTTP header field “X-Forwarded-For” is added or not; it allows the backend server to know about the user’s IP address. Possible values are on and off. Only available when the protocol is http or https.

property xForwardedForSlbId

xForwardedForSlbId: string;

Indicate whether the HTTP header field “X-Forwarded-For_SLBID” is added or not; it allows the backend server to know about the SLB ID. Possible values are on and off. Only available when the protocol is http or https.

property xForwardedForSlbIp

xForwardedForSlbIp: string;

Indicate whether the HTTP header field “X-Forwarded-For_SLBIP” is added or not; it allows the backend server to know about the SLB IP address. Possible values are on and off. Only available when the protocol is http or https.

property xForwardedForSlbProto

xForwardedForSlbProto: string;

Indicate whether the HTTP header field “X-Forwarded-For_proto” is added or not; it allows the backend server to know about the user’s protocol. Possible values are on and off. Only available when the protocol is http or https.

interface GetLoadBalancersSlb

interface GetLoadBalancersSlb

property address

address: string;

Service address of the SLBs.

property creationTime

creationTime: string;

SLB creation time.

property id

id: string;

ID of the SLB.

property internet

internet: boolean;

SLB addressType: internet if true, intranet if false. Must be false when networkType is vpc.

property masterAvailabilityZone

masterAvailabilityZone: string;

Master availability zone of the SLBs.

property name

name: string;

SLB name.

property networkType

networkType: string;

Network type of the SLBs. Valid values: vpc and classic.

property regionId

regionId: string;

Region ID the SLB belongs to.

property slaveAvailabilityZone

slaveAvailabilityZone: string;

Slave availability zone of the SLBs.

property status

status: string;

SLB current status. Possible values: inactive, active and locked.

property tags

tags: {[key: string]: any};

A map of tags assigned to the SLB instances. The tags can have a maximum of 5 tag. It must be in the format:

data "alicloud.slb.getLoadBalancers" "taggedInstances" {
tags = {
tagKey1 = "tagValue1",
tagKey2 = "tagValue2"
}
}

property vpcId

vpcId: string;

ID of the VPC linked to the SLBs.

property vswitchId

vswitchId: string;

ID of the VSwitch linked to the SLBs.

interface GetMasterSlaveServerGroupsGroup

interface GetMasterSlaveServerGroupsGroup

property id

id: string;

master slave server group ID.

property name

name: string;

master slave server group name.

property servers

servers: GetMasterSlaveServerGroupsGroupServer[];

ECS instances associated to the group. Each element contains the following attributes:

interface GetMasterSlaveServerGroupsGroupServer

interface GetMasterSlaveServerGroupsGroupServer

property instanceId

instanceId: string;

ID of the attached ECS instance.

property port

port: number;

The port used by the master slave server group.

property serverType

serverType: string;

The server type of the attached ECS instance.

property weight

weight: number;

Weight associated to the ECS instance.

interface GetRulesSlbRule

interface GetRulesSlbRule

property domain

domain: string;

Domain name in the HTTP request where the rule applies (e.g. “*.aliyun.com”).

property id

id: string;

Rule ID.

property name

name: string;

Rule name.

property serverGroupId

serverGroupId: string;

ID of the linked VServer group.

property url

url: string;

Path in the HTTP request where the rule applies (e.g. “/image”).

interface GetServerCertificatesCertificate

interface GetServerCertificatesCertificate

property alicloudCertificateId

alicloudCertificateId: string;

Id of server certificate issued by alibaba cloud. * alicloudCertificateName- Name of server certificate issued by alibaba cloud. * isAlicloudCertificate- Is server certificate issued by alibaba cloud or not.

property alicloudCertificateName

alicloudCertificateName: string;

property commonName

commonName: string;

Server certificate common name.

property createdTime

createdTime: string;

Server certificate created time.

property createdTimestamp

createdTimestamp: number;

Server certificate created timestamp.

property expiredTime

expiredTime: string;

Server certificate expired time.

property expiredTimestamp

expiredTimestamp: number;

Server certificate expired timestamp.

property fingerprint

fingerprint: string;

Server certificate fingerprint.

property id

id: string;

Server certificate ID.

property isAlicloudCertificate

isAlicloudCertificate: boolean;

property name

name: string;

Server certificate name.

property resourceGroupId

resourceGroupId?: undefined | string;

The Id of resource group which the slb server certificates belongs.

property subjectAlternativeNames

subjectAlternativeNames: string[];

Server certificate subject alternative name list.

property tags

tags?: undefined | {[key: string]: any};

A mapping of tags to assign to the resource.

interface GetServerGroupsSlbServerGroup

interface GetServerGroupsSlbServerGroup

property id

id: string;

VServer group ID.

property name

name: string;

VServer group name.

property servers

servers: GetServerGroupsSlbServerGroupServer[];

ECS instances associated to the group. Each element contains the following attributes:

interface GetServerGroupsSlbServerGroupServer

interface GetServerGroupsSlbServerGroupServer

property instanceId

instanceId: string;

ID of the attached ECS instance.

property weight

weight: number;

Weight associated to the ECS instance.

interface GetZonesZone

interface GetZonesZone

property id

id: string;

ID of the zone.

property slbSlaveZoneIds

slbSlaveZoneIds: string[];

A list of slb slave zone ids in which the slb master zone.

interface ListenerXForwardedFor

interface ListenerXForwardedFor

property retriveClientIp

retriveClientIp: boolean;

property retriveSlbId

retriveSlbId?: undefined | false | true;

Whether to use the XForwardedFor header to obtain the ID of the SLB instance. Default to false.

property retriveSlbIp

retriveSlbIp?: undefined | false | true;

Whether to use the XForwardedFor_SLBIP header to obtain the public IP address of the SLB instance. Default to false.

property retriveSlbProto

retriveSlbProto?: undefined | false | true;

Whether to use the XForwardedFor_proto header to obtain the protocol used by the listener. Default to false.

interface MasterSlaveServerGroupServer

interface MasterSlaveServerGroupServer

property port

port: number;

property serverId

serverId: string;

property serverType

serverType?: undefined | string;

property type

type?: undefined | string;

property weight

weight?: undefined | number;

interface ServerGroupServer

interface ServerGroupServer

property port

port: number;

property serverIds

serverIds: string[];

property type

type?: undefined | string;

property weight

weight?: undefined | number;

namespace vpc

interface GetCommonBandwidthPackagesPackage

interface GetCommonBandwidthPackagesPackage

property bandwidth

bandwidth: string;

The peak bandwidth of the Internet Shared Bandwidth instance.

property businessStatus

businessStatus: string;

The business status of the Common Bandwidth Package instance.

property creationTime

creationTime: string;

Time of creation.

property description

description: string;

The description of the Common Bandwidth Package instance.

property id

id: string;

ID of the Common Bandwidth Package.

property isp

isp: string;

ISP of the Common Bandwidth Package.

property name

name: string;

Name of the Common Bandwidth Package.

property publicIpAddresses

publicIpAddresses: GetCommonBandwidthPackagesPackagePublicIpAddress[];

Public ip addresses that in the Common Bandwidth Pakcage.

property resourceGroupId

resourceGroupId?: undefined | string;

The Id of resource group which the common bandwidth package belongs.

property status

status: string;

Status of the Common Bandwidth Package.

interface GetCommonBandwidthPackagesPackagePublicIpAddress

interface GetCommonBandwidthPackagesPackagePublicIpAddress

property allocationId

allocationId: string;

property ipAddress

ipAddress: string;

interface GetForwardEntriesEntry

interface GetForwardEntriesEntry

property externalIp

externalIp: string;

The public IP address.

property externalPort

externalPort: string;

The public port.

property id

id: string;

The ID of the Forward Entry.

property internalIp

internalIp: string;

The private IP address.

property internalPort

internalPort: string;

The private port.

property ipProtocol

ipProtocol: string;

The protocol type.

property name

name: string;

The forward entry name.

property status

status: string;

The status of the Forward Entry.

interface GetNatGatewaysGateway

interface GetNatGatewaysGateway

property creationTime

creationTime: string;

Time of creation.

property description

description: string;

The description of the NAT gateway.

property forwardTableId

forwardTableId: string;

The forward table id.

property id

id: string;

The ID of the NAT gateway.

property name

name: string;

Name of the NAT gateway.

property snatTableId

snatTableId: string;

The snat table id.

property spec

spec: string;

The specification of the NAT gateway.

property status

status: string;

The status of the NAT gateway.

property vpcId

vpcId: string;

The ID of the VPC.

interface GetNetworksVpc

interface GetNetworksVpc

property cidrBlock

cidrBlock: string;

Filter results by a specific CIDR block. For example: “172.16.0.0/12”.

property creationTime

creationTime: string;

Time of creation.

property description

description: string;

Description of the VPC

property id

id: string;

ID of the VPC.

property isDefault

isDefault: boolean;

Indicate whether the VPC is the default one in the specified region.

property regionId

regionId: string;

ID of the region where the VPC is located.

property routeTableId

routeTableId: string;

Route table ID of the VRouter.

property status

status: string;

Filter results by a specific status. Valid value are Pending and Available.

property tags

tags: {[key: string]: any};

A mapping of tags to assign to the resource.

property vpcName

vpcName: string;

Name of the VPC.

property vrouterId

vrouterId: string;

ID of the VRouter.

property vswitchIds

vswitchIds: string[];

List of VSwitch IDs in the specified VPC

interface GetRouteEntriesEntry

interface GetRouteEntriesEntry

property cidrBlock

cidrBlock: string;

The destination CIDR block of the route entry.

property instanceId

instanceId: string;

The instance ID of the next hop.

property nextHopType

nextHopType: string;

The type of the next hop.

property routeTableId

routeTableId: string;

The ID of the router table to which the route entry belongs.

property status

status: string;

The status of the route entry.

property type

type: string;

The type of the route entry.

interface GetRouterInterfacesInterface

interface GetRouterInterfacesInterface

property accessPointId

accessPointId: string;

ID of the access point used by the VBR.

property creationTime

creationTime: string;

Router interface creation time.

property description

description: string;

Router interface description.

property healthCheckSourceIp

healthCheckSourceIp: string;

Source IP address used to perform health check on the physical connection.

property healthCheckTargetIp

healthCheckTargetIp: string;

Destination IP address used to perform health check on the physical connection.

property id

id: string;

Router interface ID.

property name

name: string;

Router interface name.

property oppositeInterfaceId

oppositeInterfaceId: string;

ID of the peer router interface.

property oppositeInterfaceOwnerId

oppositeInterfaceOwnerId: string;

Account ID of the owner of the peer router interface.

property oppositeRegionId

oppositeRegionId: string;

Peer router region ID.

property oppositeRouterId

oppositeRouterId: string;

Peer router ID.

property oppositeRouterType

oppositeRouterType: string;

Router type in the peer region. Possible values: VRouter and VBR.

property role

role: string;

Role of the router interface. Valid values are InitiatingSide (connection initiator) and AcceptingSide (connection receiver). The value of this parameter must be InitiatingSide if the routerType is set to VBR.

property routerId

routerId: string;

ID of the VRouter located in the local region.

property routerType

routerType: string;

Router type in the local region. Valid values are VRouter and VBR (physical connection).

property specification

specification: string;

Specification of the link, such as Small.1 (10Mb), Middle.1 (100Mb), Large.2 (2Gb), …etc.

property status

status: string;

Expected status. Valid values are Active, Inactive and Idle.

property vpcId

vpcId: string;

ID of the VPC that owns the router in the local region.

interface GetRouteTablesTable

interface GetRouteTablesTable

property creationTime

creationTime: string;

Time of creation.

property description

description: string;

The description of the route table instance.

property id

id: string;

ID of the Route Table.

property name

name: string;

Name of the route table.

property routeTableType

routeTableType: string;

The type of route table.

property routerId

routerId: string;

Router Id of the route table.

interface GetSnatEntriesEntry

interface GetSnatEntriesEntry

property id

id: string;

The ID of the Snat Entry.

property snatIp

snatIp: string;

The public IP of the Snat Entry.

property sourceCidr

sourceCidr: string;

The source CIDR block of the Snat Entry.

property status

status: string;

The status of the Snat Entry.

interface GetSslVpnClientCertsCert

interface GetSslVpnClientCertsCert

property createTime

createTime: string;

The time of creation.

property endTime

endTime: number;

The expiration time of the client certificate.

property id

id: string;

ID of the SSL-VPN client certificate.

property name

name: string;

The name of the SSL-VPN client certificate.

property sslVpnServerId

sslVpnServerId: string;

Use the SSL-VPN server ID as the search key.

property status

status: string;

The status of the client certificate. valid value:expiring-soon, normal, expired.

interface GetSslVpnServersServer

interface GetSslVpnServersServer

property cipher

cipher: string;

The encryption algorithm used.

property clientIpPool

clientIpPool: string;

The IP address pool of the client.

property compress

compress: boolean;

Whether to compress.

property connections

connections: number;

The number of current connections.

property createTime

createTime: string;

The time of creation.

property id

id: string;

The ID of the SSL-VPN server.

property internetIp

internetIp: string;

The public IP.

property localSubnet

localSubnet: string;

The local subnet of the VPN connection.

property maxConnections

maxConnections: number;

The maximum number of connections.

property name

name: string;

The name of the SSL-VPN server.

property port

port: number;

The port used by the SSL-VPN server.

property proto

proto: string;

The protocol used by the SSL-VPN server.

property vpnGatewayId

vpnGatewayId: string;

Use the VPN gateway ID as the search key.

interface GetSwitchesVswitch

interface GetSwitchesVswitch

property cidrBlock

cidrBlock: string;

Filter results by a specific CIDR block. For example: “172.16.0.0/12”.

property creationTime

creationTime: string;

Time of creation.

property description

description: string;

Description of the VSwitch.

property id

id: string;

ID of the VSwitch.

property instanceIds

instanceIds: string[];

List of ECS instance IDs in the specified VSwitch.

property isDefault

isDefault: boolean;

Indicate whether the VSwitch is created by the system.

property name

name: string;

Name of the VSwitch.

property vpcId

vpcId: string;

ID of the VPC that owns the VSwitch.

property zoneId

zoneId: string;

The availability zone of the VSwitch.

interface NatGatewayBandwidthPackage

interface NatGatewayBandwidthPackage

property bandwidth

bandwidth: number;

property ipCount

ipCount: number;

property publicIpAddresses

publicIpAddresses: string;

property zone

zone: string;

interface NetworkAclAttachmentResource

interface NetworkAclAttachmentResource

property resourceId

resourceId: string;

The resource id that the network acl will associate with.

property resourceType

resourceType: string;

The resource id that the network acl will associate with. Only support VSwitch now.

interface NetworkAclEntriesEgress

interface NetworkAclEntriesEgress

property description

description?: undefined | string;

The description of the egress entry.

property destinationCidrIp

destinationCidrIp?: undefined | string;

The destination ip of the egress entry.

property entryType

entryType?: undefined | string;

The entry type of the egress entry. It must be custom or system. Default value is custom.

property name

name?: undefined | string;

The name of the egress entry.

property policy

policy?: undefined | string;

The policy of the egress entry. It must be accept or drop.

property port

port?: undefined | string;

The port of the egress entry.

property protocol

protocol?: undefined | string;

The protocol of the egress entry.

interface NetworkAclEntriesIngress

interface NetworkAclEntriesIngress

property description

description?: undefined | string;

The description of the egress entry.

property entryType

entryType?: undefined | string;

The entry type of the egress entry. It must be custom or system. Default value is custom.

property name

name?: undefined | string;

The name of the egress entry.

property policy

policy?: undefined | string;

The policy of the egress entry. It must be accept or drop.

property port

port?: undefined | string;

The port of the egress entry.

property protocol

protocol?: undefined | string;

The protocol of the egress entry.

property sourceCidrIp

sourceCidrIp?: undefined | string;

The source ip of the ingress entry.

namespace vpn

interface ConnectionIkeConfig

interface ConnectionIkeConfig

property ikeAuthAlg

ikeAuthAlg?: undefined | string;

The authentication algorithm of phase-one negotiation. Valid value: md5 | sha1 | sha256 | sha384 | sha512 |. Default value: sha1

property ikeEncAlg

ikeEncAlg?: undefined | string;

The encryption algorithm of phase-one negotiation. Valid value: aes | aes192 | aes256 | des | 3des. Default Valid value: aes

property ikeLifetime

ikeLifetime?: undefined | number;

The SA lifecycle as the result of phase-one negotiation. The valid value of n is [0, 86400], the unit is second and the default value is 86400.

property ikeLocalId

ikeLocalId?: undefined | string;

The identification of the VPN gateway.

property ikeMode

ikeMode?: undefined | string;

The negotiation mode of IKE V1. Valid value: main (main mode) | aggressive (aggressive mode). Default value: main

property ikePfs

ikePfs?: undefined | string;

The Diffie-Hellman key exchange algorithm used by phase-one negotiation. Valid value: group1 | group2 | group5 | group14 | group24. Default value: group2

property ikeRemoteId

ikeRemoteId?: undefined | string;

The identification of the customer gateway.

property ikeVersion

ikeVersion?: undefined | string;

The version of the IKE protocol. Valid value: ikev1 | ikev2. Default value: ikev1

property psk

psk?: undefined | string;

Used for authentication between the IPsec VPN gateway and the customer gateway.

interface ConnectionIpsecConfig

interface ConnectionIpsecConfig

property ipsecAuthAlg

ipsecAuthAlg?: undefined | string;

The authentication algorithm of phase-two negotiation. Valid value: md5 | sha1 | sha256 | sha384 | sha512 |. Default value: sha1

property ipsecEncAlg

ipsecEncAlg?: undefined | string;

The encryption algorithm of phase-two negotiation. Valid value: aes | aes192 | aes256 | des | 3des. Default value: aes

property ipsecLifetime

ipsecLifetime?: undefined | number;

The SA lifecycle as the result of phase-two negotiation. The valid value is [0, 86400], the unit is second and the default value is 86400.

property ipsecPfs

ipsecPfs?: undefined | string;

The Diffie-Hellman key exchange algorithm used by phase-two negotiation. Valid value: group1 | group2 | group5 | group14 | group24| disabled. Default value: group2

interface GetConnectionsConnection

interface GetConnectionsConnection

property createTime

createTime: string;

property customerGatewayId

customerGatewayId: string;

Use the VPN customer gateway ID as the search key.

property effectImmediately

effectImmediately: boolean;

property id

id: string;

ID of the VPN connection.

property ikeConfigs

ikeConfigs?: GetConnectionsConnectionIkeConfig[];

The configurations of phase-one negotiation.

property ipsecConfigs

ipsecConfigs?: GetConnectionsConnectionIpsecConfig[];

The configurations of phase-two negotiation.

property localSubnet

localSubnet: string;

The local subnet of the VPN connection.

property name

name: string;

The name of the VPN connection.

property remoteSubnet

remoteSubnet: string;

The remote subnet of the VPN connection.

property status

status: string;

The status of the VPN connection, valid value:ike_sa_not_established, ike_sa_established, ipsec_sa_not_established, ipsec_sa_established.

property vpnGatewayId

vpnGatewayId: string;

Use the VPN gateway ID as the search key.

interface GetConnectionsConnectionIkeConfig

interface GetConnectionsConnectionIkeConfig

property ikeAuthAlg

ikeAuthAlg?: undefined | string;

The authentication algorithm of phase-one negotiation.

property ikeEncAlg

ikeEncAlg?: undefined | string;

The encryption algorithm of phase-one negotiation.

property ikeLifetime

ikeLifetime?: undefined | number;

The SA lifecycle as the result of phase-one negotiation.

property ikeLocalId

ikeLocalId?: undefined | string;

The identification of the VPN gateway.

property ikeMode

ikeMode?: undefined | string;

The negotiation mode of IKE phase-one.

property ikePfs

ikePfs?: undefined | string;

The Diffie-Hellman key exchange algorithm used by phase-one negotiation.

property ikeRemoteId

ikeRemoteId?: undefined | string;

The identification of the customer gateway.

property ikeVersion

ikeVersion?: undefined | string;

The version of the IKE protocol.

property psk

psk?: undefined | string;

Used for authentication between the IPsec VPN gateway and the customer gateway.

interface GetConnectionsConnectionIpsecConfig

interface GetConnectionsConnectionIpsecConfig

property ipsecAuthAlg

ipsecAuthAlg?: undefined | string;

The authentication algorithm of phase-two negotiation.

property ipsecEncAlg

ipsecEncAlg?: undefined | string;

The encryption algorithm of phase-two negotiation.

property ipsecLifetime

ipsecLifetime?: undefined | number;

The SA lifecycle as the result of phase-two negotiation.

property ipsecPfs

ipsecPfs?: undefined | string;

The Diffie-Hellman key exchange algorithm used by phase-two negotiation.

interface GetCustomerGatewaysGateway

interface GetCustomerGatewaysGateway

property createTime

createTime: string;

The creation time of the VPN customer gateway.

property description

description: string;

The description of the VPN customer gateway.

property id

id: string;

ID of the VPN customer gateway .

property ipAddress

ipAddress: string;

The ip address of the VPN customer gateway.

property name

name: string;

The name of the VPN customer gateway.

interface GetGatewaysGateway

interface GetGatewaysGateway

property businessStatus

businessStatus: string;

Limit search to specific business status - valid value is “Normal”, “FinancialLocked”.

property createTime

createTime: string;

The creation time of the VPN gateway.

property description

description: string;

The description of the VPN

property enableIpsec

enableIpsec: string;

Whether the ipsec function is enabled.

property enableSsl

enableSsl: string;

Whether the ssl function is enabled.

property endTime

endTime: string;

The expiration time of the VPN gateway.

property id

id: string;

ID of the VPN.

property instanceChargeType

instanceChargeType: string;

The charge type of the VPN gateway.

property internetIp

internetIp: string;

The internet ip of the VPN.

property name

name: string;

The name of the VPN.

property specification

specification: string;

The Specification of the VPN

property sslConnections

sslConnections: number;

Total count of ssl vpn connections.

property status

status: string;

Limit search to specific status - valid value is “Init”, “Provisioning”, “Active”, “Updating”, “Deleting”.

property vpcId

vpcId: string;

Use the VPC ID as the search key.

namespace waf

interface DomainLogHeader

interface DomainLogHeader

property key

key?: undefined | string;

property value

value?: undefined | string;

interface GetDomainsDomain

interface GetDomainsDomain

property domain

domain: string;

Name of the domain.

namespace yundun

interface GetBastionHostInstancesInstance

interface GetBastionHostInstancesInstance

property description

description: string;

The instance’s remark.

property id

id: string;

The instance’s id.

property instanceStatus

instanceStatus: string;

The instance’s status.

property licenseCode

licenseCode: string;

property privateDomain

privateDomain: string;

The instance’s private domain name.

property publicDomain

publicDomain: string;

The instance’s public domain name.

property publicNetworkAccess

publicNetworkAccess: boolean;

The instance’s public network access configuration.

property securityGroupIds

securityGroupIds: string[];

The instance’s security group configuration.

property tags

tags?: undefined | {[key: string]: any};

A map of tags assigned to the bastionhost instance. It must be in the format:

data "alicloud.yundun.getBastionHostInstances" "instance" {
tags = {
tagKey1 = "tagValue1"
}
}

property userVswitchId

userVswitchId: string;

The instance’s vSwitch ID.

interface GetDBAuditInstanceInstance

interface GetDBAuditInstanceInstance

property description

description: string;

property id

id: string;

property instanceStatus

instanceStatus: string;

property licenseCode

licenseCode: string;

property privateDomain

privateDomain: string;

property publicDomain

publicDomain: string;

property publicNetworkAccess

publicNetworkAccess: boolean;

property tags

tags?: undefined | {[key: string]: any};

property userVswitchId

userVswitchId: string;

APIs

interface GetRegionsRegion

interface GetRegionsRegion

property id

id: string;

ID of the region.

property localName

localName: string;

Name of the region in the local language.

property regionId

regionId: string;

interface GetZonesZone

interface GetZonesZone

property availableDiskCategories

availableDiskCategories: string[];

Set of supported disk categories.

property availableInstanceTypes

availableInstanceTypes: string[];

Allowed instance types.

property availableResourceCreations

availableResourceCreations: string[];

Filter the results by a specific resource type. Valid values: Instance, Disk, VSwitch, Rds, KVStore, FunctionCompute, Elasticsearch, Slb.

property id

id: string;

ID of the zone.

property localName

localName: string;

Name of the zone in the local language.

property multiZoneIds

multiZoneIds: string[];

A list of zone ids in which the multi zone.

property slbSlaveZoneIds

slbSlaveZoneIds: string[];

A list of slb slave zone ids in which the slb master zone.