GetVpcEndpointServiceAttribute - - Alibaba Cloud ドキュメントセンター

GetVpcEndpointServiceAttribute 操作を呼び出して、エンドポイントサービスの属性を照会できます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

privatelink:GetVpcEndpointServiceAttribute

get

*VpcEndpointService

acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	エンドポイントサービスがデプロイされているリージョンの ID です。 DescribeRegions 操作を呼び出すことで、リージョン ID を取得できます。	cn-huhehaote
ServiceId	string	必須	エンドポイントサービスの ID です。	epsrv-hp3vpx8yqxblby3i****
RegionId	string	必須	エンドポイントサービスがデプロイされているリージョンの ID です。 DescribeRegions 操作を呼び出すことで、リージョン ID を取得できます。	cn-huhehaote

レスポンスフィールド

フィールド	型	説明	例
	object
Payer	string	支払者。有効値： Endpoint：サービス利用者。 EndpointService：サービスプロバイダー。	Endpoint
RequestId	string	リクエスト ID です。	8D8992C1-6712-423C-BAC5-E5E817484C6B
ServiceDescription	string	エンドポイントサービスの説明です。	This is my EndpointService.
CreateTime	string	エンドポイントサービスが作成された時刻です。	2020-01-02T19:11:12Z
MaxBandwidth	integer	エンドポイント接続の最大帯域幅。単位：Mbps。	1024
MinBandwidth	integer	エンドポイント接続の最小帯域幅。単位：Mbps。	100
ServiceDomain	string	エンドポイントサービスのドメイン名です。	epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com
AutoAcceptEnabled	boolean	エンドポイント接続を自動的に承諾するかどうかを示します。有効値： true：エンドポイント接続は自動的に承諾されます。 false：エンドポイント接続は自動的に承諾されません。	true
ZoneAffinityEnabled	boolean	ゾーンアフィニティが有効かどうかを示します。有効値： true (デフォルト)：ゾーンアフィニティは有効です。 false：ゾーンアフィニティは無効です。	true
ServiceId	string	エンドポイントサービスの ID です。	epsrv-hp3vpx8yqxblby3i****
Zones	array	サービスリソースがデプロイされているゾーンです。
	string	サービスリソースがデプロイされているゾーンです。	cn-huhehaote-b
ServiceBusinessStatus	string	エンドポイントサービスのビジネスステータス。有効値： Normal：エンドポイントサービスは正常に実行されています。 FinancialLocked：支払い遅延により、エンドポイントサービスはロックされています。	Normal
ServiceName	string	エンドポイントサービスの名前です。	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
ServiceStatus	string	エンドポイントサービスのステータス。有効値： Creating：エンドポイントサービスは作成中です。 Pending：エンドポイントサービスは変更中です。 Active：エンドポイントサービスは利用可能です。 Deleting：エンドポイントサービスは削除中です。	Active
ConnectBandwidth	integer	デフォルトの最大帯域幅。単位：Mbps。値の範囲は 100～10240 です。	3072
RegionId	string	エンドポイントサービスがデプロイされているリージョンです。	cn-huhehaote
ServiceType	string	エンドポイントのタイプ。 Interface：インターフェイスエンドポイント。Classic Load Balancer (CLB)、Application Load Balancer (ALB)、および Network Load Balancer (NLB) インスタンスをサービスリソースとして追加できます。 GatewayLoadBalancer：Gateway Load Balancer エンドポイント。Gateway Load Balancer (GWLB) インスタンスをサービスリソースとして追加できます。	Interface
ServiceResourceType	string	サービスリソースのタイプ。有効値： slb：サービスリソースは Classic Load Balancer (CLB) インスタンスです。 alb：サービスリソースは Application Load Balancer (ALB) インスタンスです。 nlb：サービスリソースは Network Load Balancer (NLB) インスタンスです。 gwlb：サービスリソースは Gateway Load Balancer (GWLB) インスタンスです。	slb
ServiceSupportIPv6 `deprecated`	boolean	エンドポイントサービスが IPv6 をサポートしているかどうかを示します。有効値： true：はい。 false (デフォルト)：いいえ。	false
ResourceGroupId	string	リソースグループの ID です。	rg-acfmy*****
AddressIpVersion	string	IP アドレスのバージョン。有効値： IPv4：IPv4。 DualStack：デュアルスタック。	IPv4
SupportedRegionSet	array<object>
	object
ServiceRegionId	string
RegionServiceStatus	string
RegionBusinessStatus	string

例

成功レスポンス

JSONJSON

{
  "Payer": "Endpoint",
  "RequestId": "8D8992C1-6712-423C-BAC5-E5E817484C6B",
  "ServiceDescription": "This is my EndpointService.",
  "CreateTime": "2020-01-02T19:11:12Z",
  "MaxBandwidth": 1024,
  "MinBandwidth": 100,
  "ServiceDomain": "epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com",
  "AutoAcceptEnabled": true,
  "ZoneAffinityEnabled": true,
  "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
  "Zones": [
    "cn-huhehaote-b"
  ],
  "ServiceBusinessStatus": "Normal",
  "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****",
  "ServiceStatus": "Active",
  "ConnectBandwidth": 3072,
  "RegionId": "cn-huhehaote",
  "ServiceType": "Interface",
  "ServiceResourceType": "slb",
  "ServiceSupportIPv6": false,
  "ResourceGroupId": "rg-acfmy*****",
  "AddressIpVersion": "IPv4",
  "SupportedRegionSet": [
    {
      "ServiceRegionId": "",
      "RegionServiceStatus": "",
      "RegionBusinessStatus": ""
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	EndpointServiceNotFound	The specified Service does not exist.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。