GetVpcEndpointServiceAttribute 呼び出しによるサービス設定のクエリ - PrivateLink - Alibaba Cloud - PrivateLink

現在のアカウントに属するエンドポイントサービスの属性を照会します。

今すぐお試しください

この 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 を呼び出して、最新のリージョンリストを取得できます。	cn-huhehaote
ServiceId	string	必須	エンドポイントサービスの ID。	epsrv-hp3vpx8yqxblby3i****
RegionId	string	必須	エンドポイントサービスが所在するリージョンの ID です。 DescribeRegions API を呼び出して、リージョン ID を取得できます。	cn-huhehaote

レスポンスフィールド

フィールド	型	説明	例
	object
Payer	string	支払者。有効な値: Endpoint: サービス利用者。 EndpointService: サービスプロバイダー。	Endpoint
RequestId	string	リクエスト ID。	8D8992C1-6712-423C-BAC5-E5E817484C6B
ServiceDescription	string	エンドポイントサービスの説明。	これは私のエンドポイントサービスです。
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: 滞納ロック。	法線
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 エンドポイント (GWLBe)。Gateway Load Balancer (GWLB) インスタンスをサービスリソースとして追加できます。	Interface
ServiceResourceType	string	EPS リソースタイプ。有効な値: slb: EPS リソースタイプは Classic Load Balancer (CLB) です。 alb: EPS リソースタイプは Application Load Balancer (ALB) です。 nlb: EPS リソースタイプは Network Load Balancer (NLB) です。 gwlb: EPS リソースタイプは Gateway Load Balancer (GWLB) です。	slb
ServiceSupportIPv6 `deprecated`	boolean	エンドポイントサービスで IPv6 がサポートされているかどうかを示します。有効な値: true: IPv6 がサポートされています。 false (デフォルト): IPv6 はサポートされていません。	false
ResourceGroupId	string	リソースグループの ID。	rg-acfmy*****
AddressIpVersion	string	プロトコルバージョン。有効な値: IPv4: IPv4。 DualStack: デュアルスタック。	IPv4
SupportedRegionSet	array<object>	エンドポイントサービスでサポートされているリージョンのリスト。サービス利用者はこのリストにあるリージョンからエンドポイント接続を開始できます。
	object
ServiceRegionId `deprecated`	string
RegionServiceStatus	string	エンドポイントサービスでサポートされているリージョンのステータス。有効な値: Pending: 変更済み。 Available: 利用可能。 Deleting: 削除中。 Failed: 失敗した。 Closed: クローズ。	Available
RegionBusinessStatus	string	エンドポイントサービスでサポートされているリージョンのビジネスステータス。有効な値: Normal: 法線。 FinancialLocked: 滞納ロック。	法線
SupportedRegionId	string	エンドポイントサービスでサポートされているリージョンの ID。	cn-hangzhou

例

成功レスポンス

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": "Available",
      "RegionBusinessStatus": "Normal",
      "SupportedRegionId": "cn-hangzhou"
    }
  ]
}

エラーコード

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

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

変更履歴

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